- recuperer_touches_evt_souris
- fixer_touches_evt_souris
- gd_lire_donnees
- gd_vider_donnees
- gd_donnees_disponibles
- gd_ecrire_donnees
- gd_executer_glissement
- mettre_focus
- ajouter_image
- ajouter_image_url
- rafraichir_liste
- liste_ogb
- supprimer_image
- exporter_liste
- fixer_colonnes_figees
- effacer_indicateurs_tri
- executer_filtres_auto
- fixer_valeur_colonnes
- initialiser_champs_filtres
- fixer_mode_execution
- fixer_proprietes_colonnes
- recuperer_colonnes_figees
- recuperer_coordonnees_cellule
- rafraichir_colonnes
- recuperer_colonnes
- recuperer_proprietes_colonnes
- recuperer_valeur_colonnes
- recuperer_hauteur_ligne
- recuperer_mode_execution
- ajouter_image2
Sens affectés aux paramètres des méthodes :
(E) |
Entrée |
(S) |
Sortie |
(E/S) |
Entrée et Sortie |
AJOUTER_IMAGE
Ajoute une image à la fin de la liste d'images de l'objet.
Les images possèdent un numéro implicite qui correspond à leur position dans la liste, la première image ayant le numéro 1.
Remarque : Pour insérer une image dans la liste graphique, l'utilisateur doit fixer le type Image pour la propriété Type Adélia de l'objet colonne et affecter à la propriété Valeur le numéro de l'image qu'il souhaite afficher.
| Syntaxe | |||||
APPELER_METHODE NomObjetListe AJOUTER_IMAGE NomFichier CodeRetour |
|||||
Paramètres |
|||||
CHAR(250) NomFichier |
Chemin d'accès et nom du fichier image. (Les extensions admises pour le fichier image sont : bmp, cut, emf, eps, ico, gif, iff, jpg, jp2, mng, pbm, pcx, pgm, png, ppm, psp, tif, tga, wmf. Avec le runtime Adélia Mobile, seuls les formats suivants sont supportés : bmp, gif, jpg, png et ico.) |
||||
BOOL CodeRetour |
Code retour de l'opération. Valeurs possibles :
|
||||
Conditions d'utilisation |
Aucune |
||||
Remarque : cette méthode n'est pas mise en oeuvre par le générateur Java.
AJOUTER_IMAGE2
Ajoute une image à la fin de la liste d'images de l'objet.
Les images possèdent un numéro implicite qui correspond à leur position dans la liste, la première image ayant le numéro 1.
Remarque : Pour insérer une image dans la liste graphique, l'utilisateur doit fixer le type Image pour la propriété Type Adélia de l'objet colonne et affecter à la propriété Valeur le numéro de l'image qu'il souhaite afficher.
| Syntaxe | ||||||
APPELER_METHODE NomObjetListe AJOUTER_IMAGE2 Image CodeRetour |
||||||
Paramètres |
||||||
Image |
Type IMAGE |
Image à ajouter. Le contenu de la variable est soit une image au format DIB (Device Independent Bitmap) soit un fichier contenant une image avec comme extension possible : bmp, cut, emf, eps, ico, gif, iff, jpg, jp2, mng, pbm, pcx, pgm, png, ppm, psp, tif, tga, wmf. |
||||
CodeRetour |
Type BOOL |
Code retour de l'opération. Valeurs possibles :
|
||||
Conditions d'utilisation |
Aucune |
|||||
Remarque : cette méthode n'est pas mise en oeuvre par le générateur Mobile.
AJOUTER_IMAGE_URL
Ajoute une image à la fin de la liste d'images de l'objet.
Les images possèdent un numéro implicite qui correspond à leur position dans la liste, la première image ayant le numéro 1.
Remarque : Pour insérer une image dans la liste graphique, l'utilisateur doit fixer le type Image pour la propriété Type Adélia de l'objet colonne et affecter à la propriété Valeur le numéro de l'image qu'il souhaite afficher.
| Syntaxe | |
APPELER_METHODE NomObjetListe AJOUTER_IMAGE_URL AdresseUrl CodeRetour |
|
Paramètres |
|
ALPHA(500) AdresseUrl |
Adresse URL désignant le fichier Image (paramètre en entrée). Les extensions admises pour le fichier image sont : bmp, cut, emf, eps, ico, gif, iff, jpg, jp2, mng, pbm, pcx, pgm, png, ppm, psp, tif, tga, wmf. |
NUM_BIN_4 CodeRetour |
Code retour de l'opération (paramètre en sortie). Valeurs possibles du CodeRetour : -1 : Erreur lors de l'ajout de l'image > 0 : Erreur lors de l'exécution de la requête http 0 : Opération correctement effectuée Attention : la valeur du code retour n'a aucune signification en génération Cloud. |
Conditions d'utilisation |
Aucune |
Remarque : cette méthode n'est mise en oeuvre ni par le générateur Java, ni par le générateur Mobile.
EFFACER_INDICATEURS_TRI
Efface les indicateurs de tri des en-têtes de colonne de la liste et fixe la propriété INDICATEUR_TRI des colonnes permettant un tri à _COL_INDIC_TRI_AUTORISE.
| Syntaxe | |||||
APPELER_METHODE NomObjetListe EFFACER_INDICATEURS_TRI CodeRetour |
|||||
Paramètres |
|||||
BOOL CodeRetour |
Code retour de l'opération. Valeurs possibles :
|
||||
Conditions d'utilisation |
Aucune |
||||
Remarque : cette méthode n'est mise en oeuvre ni en génération Java ni en génération Mobile.
EXECUTER_FILTRES_AUTO
Rend visible toutes les lignes de la liste et exécute les filtres automatiques définis sur toutes les colonnes.
Cette méthode est utile dans une liste où à la fois des filtres manuels et automatiques ont été définis. Dans ce cas l'utilisateur peut, dans l'événement ACTION_FILTRE des colonnes définies avec un filtre manuel, exécuter tous les filtres automatiques avant d'exécuter son filtre personnalisé.
Attention : après l'exécution de la méthode, l'événement AprèsFiltreAuto est déclenché.
| Syntaxe | |||||
APPELER_METHODE NomObjetListe EXECUTER_FILTRES_AUTO CodeRetour |
|||||
Paramètres |
|||||
BOOL CodeRetour |
Code retour de l'opération.
|
||||
Conditions d'utilisation |
Aucune |
||||
Remarque : cette méthode n'est mise en œuvre ni en génération Java ni en génération Mobile.
EXPORTER_LISTE
Permet d'exporter le contenu de la liste graphique vers un fichier ASCII délimité (fichier texte ou ".csv") ou vers un fichier Excel formaté. Dans le dernier cas, une grande partie des propriétés de l'objet sont reprises dans l'exportation.
Seules les colonnes visibles de la liste sont exportées.
| Syntaxe | |||||||||||||||
APPELER_METHODE NomObjetListe EXPORTER_LISTE NomFichier FormatFichier NomFeuilleOuSéparateur CodeRetour |
|||||||||||||||
Paramètres |
|||||||||||||||
ALPHA(250) NomFichier (E) |
Chemin complet du fichier à créer. |
||||||||||||||
NUM_BIN_2 FormatFichier (E) |
Format du fichier à créer.
Valeurs possibles :
Remarque : les formats _LST_EXP_FORMAT_TEXTE et _LST_EXP_FORMAT_CSV sont dépréciés car l'implémentation était différente entre Windows (présence des en-têtes de colonne dans le fichier généré) et Cloud (les en-têtes de colonne étaient absentes). Vous devez utiliser les formats "_AVEC_ENTETE" et "_SANS_ENTETE" pour spécifier explicitement si vous souhaitez générer les en-têtes de colonne. |
||||||||||||||
ALPHA(250) NomFeuilleOuSéparateur (E) |
Si le format d'export (FormatFichier) vaut _LST_EXP_FORMAT_EXCEL, ce paramètre correspond au nom de la feuille Excel dans laquelle est effectuée l'exportation. Si le format vaut _LST_EXP_FORMAT_CSV, le premier caractère est pris comme le séparateur du format. Si le paramètre est à blanc le séparateur est le ';'. |
||||||||||||||
BOOL CodeRetour (S) |
Code retour de l'opération (à *VRAI si l'opération s'est bien déroulée). |
||||||||||||||
Conditions d'utilisation |
Aucune |
||||||||||||||
Remarque :
En génération client Windows, s'il existe une configuration Middleware utilisant le serveur logique *DOC_SERVER associé à un Daemon Middleware Java, la méthode se comporte de la même façon qu'en génération Cloud, comme indiqué ci-dessous.
En revanche, si la configuration de *DOC_SERVER n'est pas active, les types de données ne sont pas conservés et les cellules Excel ont toutes le format texte.
Note pour la génération Client Windows avec configuration *DOC_SERVER ou Client Cloud :
En fonction de l'extension du fichier (.xls ou .xlsx) renseigné dans la méthode, le fichier produit sera au format XLS ou XLSX.
Les types de données numériques et dates sont conservés lors de l'export. Cela implique un certain nombre de limitations :
- Les données DATE et TIMESTAMP de valeur antérieure au 1er janvier 1900 ne peuvent pas être représentées et apparaissent en erreur dans Excel.
- Excel est limité à 15 chiffres significatifs pour les types numériques. Les données numériques d'une précision supérieure dans Adélia (NUM_BIN_8, NUM_E de grande précision) pourront être arrondies.
- Il n'est pas possible de masquer le séparateur décimal. Celui-ci sera forcé quel que soit le code d'édition ou le mot d'édition donné. Le code d'édition Z, notamment, sera affiché comme le code d'édition 4 dans le fichier Excel, et l'affichage du code d'édition Y sera incorrect si le type de données contient des décimales.
- Les positions des caractères de séparateur décimal et de séparateur de milliers ("." et ",") doivent être consistantes dans un mot d'édition. Si elles le sont, les séparateurs seront affichés correctement dans le format Excel généré, sinon ils seront assimilés à des caractères standard dans le format généré. Dans tous les cas, pour les caractères numériques à décimales, le séparateur décimal sera affiché.
- Dans un mot d'édition Adélia, les caractères non numériques situés à gauche du premier chiffre affiché ne sont pas visibles. Dans le format Excel, ils le seront de façon systématique.
FIXER_COLONNES_FIGEES
Fige un ou plusieurs objets COLONNE. Une colonne figée est une colonne insensible aux actions sur la barre de défilement horizontale. Les colonnes figées sont consécutives à partir du côté gauche de l'objet.
| Syntaxe | |||||||||
APPELER_METHODE NomObjetListe FIXER_COLONNES_FIGEES NbColonnes CodeRetour |
|||||||||
Paramètres |
|||||||||
NUM_BIN_4 NbColonnes |
Nombre de colonnes consécutives à figer (les colonnes sont ordonnées de gauche à droite). Ce nombre doit prendre en compte les colonnes non visibles. |
||||||||
NUM_BIN_2 CodeRetour |
Code retour de l'opération.
Valeurs possibles :
|
||||||||
Conditions d'utilisation |
Aucune Pour défiger des colonnes figées, passer 0 comme valeur du paramètre NbColonnes à l'appel de cette méthode. |
||||||||
Remarque : cette méthode n'est pas mise en oeuvre par le générateur Java.
FIXER_MODE_EXECUTION
Permet de faire passer l'objet du mode sélection (ligne ou cellule) au mode saisie, et inversement. Le mode choisi peut être figé (l'utilisateur ne peut plus passer d'un mode à l'autre via l'interface).
| Syntaxe | |||||||||||
APPELER_METHODE NomObjetListe FIXER_MODE_EXECUTION Mode EtatMode CodeRetour |
|||||||||||
Paramètres |
|||||||||||
NUM_BIN_2 Mode |
Définit le nouveau mode de l'objet. Si le nouveau mode est identique à l'ancien, seul le paramètre EtatMode est pris en compte.
Valeurs possibles :
|
||||||||||
BOOL EtatMode |
Définit l'état persistant du mode. Si la valeur est *VRAI, le mode est figé (seulement pour l'interface) ; sinon il est modifiable par l'utilisateur. |
||||||||||
NUM_BIN_2 CodeRetour |
Code retour de l'opération.
Valeurs possibles :
|
||||||||||
Conditions d'utilisation |
Le mode fixé est pris en compte tant que la liste n'est pas vide. Une liste vidée passe automatiquement en mode sélection (ligne ou cellule) non persistant. |
||||||||||
FIXER_PROPRIETES_COLONNES
Fixe les propriétés modifiables des cellules qui constituent la ligne dont le numéro est indiqué dans NumLigne .
Les propriétés mises à jour sont : ALIGNEMENT, COULEUR_FOND, COULEUR_TEXTE, INVERSION_IMAGE, LECTURE_SEULE, POLICE et VALEUR.
| Syntaxe | |
APPELER_METHODE NomObjetListe FIXER_PROPRIETES_COLONNES NumLigne CodeRetour |
|
Paramètres |
|
NUM_BIN_4 NumLigne |
Numéro de la ligne. Si NumLigne vaut 0, il prend la valeur de la propriété NUMERO_LIGNE_COURANTE (rang de la dernière ligne active). |
BOOL CodeRetour |
Code retour de l'opération. Le paramètre CodeRetour est *VRAI si l'opération s'est bien effectuée. Dans le cas contraire, il est *FAUX (dans le cas où NumLigne ne correspond à aucune ligne). |
Conditions d'utilisation |
Aucune |
FIXER_TOUCHES_EVT_SOURIS
Permet de définir les touches du clavier pour lesquelles on souhaite récupérer l'état (enfoncé/non enfoncé) au moment de l'événement "MouvementSouris" de la liste.
Cette méthode doit être utilisée avant l'appel de la méthode RECUPERER_TOUCHES_EVT_SOURIS du même objet.
| Syntaxe | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
APPELER_METHODE NomObjetListe FIXER_TOUCHES_EVT_SOURIS TestToucheMaj TestToucheCtrl TestToucheAlt TabAlphaNum TabAutresTouches TailleTabAutresTouches CodeRetour |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Paramètres |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BOOL TestToucheMaj (E) |
Indique si l'on doit tester l'état de la touche clavier Maj lors de l'appel à la méthode RECUPERER_TOUCHES_EVT_SOURIS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BOOL TestToucheCtrl (E) |
Indique si l'on doit tester l'état de la touche clavier Ctrl lors de l'appel à la méthode RECUPERER_TOUCHES_EVT_SOURIS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BOOL TestToucheAlt (E) |
Indique si l'on doit tester l'état de la touche clavier Alt lors de l'appel à la méthode RECUPERER_TOUCHES_EVT_SOURIS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ALPHA(36) AlphaNum (E) |
Chaîne contenant les caractères alphanumériques de A à Z et les caractères numériques de 0 à 9 représentant les touches du clavier qui doivent être testées lors de l'appel à la méthode RECUPERER_TOUCHES_EVT_SOURIS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Tableau de NUM_BIN2 TabAutresTouches (E) |
Tableau contenant les valeurs représentant les autres touches du clavier qui doivent être testées lors de l'appel à la méthode RECUPERER_TOUCHES_EVT_SOURIS. Les valeurs correspondant aux touches sont indiquées ci-dessous.
Valeurs possibles :
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NUM_BIN2 TailleTabAutresTouches (E) |
Nombre d'éléments traités dans le tableau TabAutresTouches. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NUM_BIN_2 CodeRetour (S) |
Code de retour de l'opération.
Valeurs possibles :
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Conditions d'utilisation |
Aucune |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
La longueur du tableau TabAutresTouches doit être au moins égale à la taille indiquée.
Si le tableau TabAlphaNum est vide, les touches A->Z et 0->9 du clavier ne seront pas testées lors du prochain appel à la méthode RECUPERER_TOUCHES_EVT_SOURIS.
De même, si la valeur du paramètre TailleTabAutresTouches est égale à 0, alors les touches "autres" ne seront pas testées lors du prochain appel à la méthode RECUPERER_TOUCHES_EVT_SOURIS.
Remarque : cette méthode n'est mise en œuvre ni en génération Java ni en génération Mobile.
FIXER_VALEUR_COLONNES
Fixe la valeur des cellules qui constituent la ligne dont le numéro est indiqué dans NumLigne par la propriété VALEUR des objets COLONNE constituant la liste. La ligne de la liste sera elle aussi passée à l'état Modifié.
| Syntaxe | |
APPELER_METHODE NomObjetListe FIXER_VALEUR_COLONNES NumLigne CodeRetour |
|
Paramètres |
|
NUM_BIN_4 NumLigne |
Numéro de la ligne. Si NumLigne vaut 0, il prend la valeur de la propriété NUMERO_LIGNE_COURANTE (rang de la dernière ligne active). |
BOOL CodeRetour |
Code retour de l'opération. Le paramètre CodeRetour est *VRAI si l'opération s'est bien effectuée. Dans le cas contraire, il est *FAUX (dans le cas où NumLigne ne correspond à aucune ligne). |
Conditions d'utilisation |
Aucune |
GD_DONNEES_DISPONIBLES
Cette méthode indique si des données d'un format spécifié sont disponibles parmi les données concernées par l'opération de glisser-déposer en cours. Le format est un format prédéfini sous Windows, ou peut être un format défini par le développeur.
| Syntaxe | |||||||||
APPELER_METHODE NomObjetListe GD_DONNEES_DISPONIBLES Format Disponibilite CodeRetour |
|||||||||
Paramètres |
|||||||||
ALPHA(50) Format (E) |
Nom du format de données recherché.
Valeurs possibles :
|
||||||||
BOOL Disponibilite (S) |
La valeur est à *VRAI si des données du format souhaité sont disponibles. |
||||||||
NUM_BIN_4 CodeRetour (S) |
Code de retour de l'opération.
Valeurs possibles :
|
||||||||
Conditions d'utilisation |
La méthode ne peut être utilisée que sur les événements GD_EntreeGlissement, GD_SurvolGlissement et GD_Depose. |
||||||||
Remarques :
Cette méthode n'est pas mise en oeuvre par le générateur Java.
Elle n'est pas disponible en génération Mobile.
GD_ECRIRE_DONNEES
Cette méthode ajoute des données (le contenu des variables Adélia) aux données qui seront transmises par une opération de glisser-déposer. Ces informations sont stockées dans l'objet jusqu'à la fin de l'opération de glisser-déposer, puis sont effacées automatiquement.
Remarques :
- L'appel de cette méthode avec un tableau de n éléments est équivalent à n appels de cette méthode avec une variable contenant les éléments du tableau.
- Aucune distinction n'est faite entre les types numériques étendu et condensé.
| Syntaxe | |||||||
APPELER_METHODE NomObjetListe GD_ECRIRE_DONNEES VarAdelia NbDonnees CodeRetour |
|||||||
Paramètres |
|||||||
Types possibles pour le paramètre VarAdelia (E) : ALPHA, DATE, TIME, NUM_E, NUM_P, NUM_BIN_2, NUM_BIN_4, BOOL, TIMESTAMP, IMAGE |
Variable ou tableau contenant les données. |
||||||
NUM_BIN_4 NbDonnees (E/S) |
Nombre d'informations à ajouter. Ce paramètre doit être égal à 1 pour une variable, et doit être inférieur ou égal au nombre d'éléments du tableau pour un tableau. Après appel de la méthode, il contient le nombre d'informations écrites. |
||||||
NUM_BIN_4 CodeRetour (S) |
Code de retour de l'opération.
Valeurs possibles :
|
||||||
Conditions d'utilisation |
Aucune |
||||||
Remarques :
Cette méthode n'est pas mise en oeuvre par le générateur Java.
Elle n'est pas disponible en génération Mobile.
GD_EXECUTER_GLISSEMENT
Cette méthode provoque le début d'une opération de glisser-déposer entre un objet source et un objet cible avec les données stockées dans l'objet source par la méthode GD_ECRIRE_DONNEES.
Les données concernées peuvent être soit copiées, soit déplacées dans l'objet cible.
L'ensemble de ces données est identifié par un nom de format. Le format est un format prédéfini sous Windows, ou peut être un format défini par le développeur.
Remarque : dans le cas de l'utilisation d'un format prédéfini, seule la première donnée écrite par la méthode GD_ECRIRE_DONNEES est prise en compte.
| Syntaxe | |||||||||||
APPELER_METHODE NomObjetListe GD_EXECUTER_GLISSEMENT Format ActionsPermises ActionFaite CodeRetour |
|||||||||||
Paramètres |
|||||||||||
ALPHA(50) Format (E) |
Nom du format de données.
Valeurs possibles :
Une chaîne quelconque qui ne commence pas par "CF_" pour un format défini par le développeur, et qui regroupe l'ensemble des données écrites. |
||||||||||
NUM_BIN_4 ActionsPermises (E) |
Actions permises dans l'objet cible.
Valeurs possibles :
Une chaîne quelconque qui ne commence pas par "CF_" pour un format défini par le développeur, et qui regroupe l'ensemble des données écrites. |
||||||||||
NUM_BIN_4 ActionFaite (S) |
Action effectuée dans l'objet cible.
Valeurs possibles :
|
||||||||||
NUM_BIN_4 CodeRetour (S) |
Code de retour de l'opération.
Valeurs possibles :
|
||||||||||
Conditions d'utilisation |
La méthode doit être utilisée sur l'événement GD_DebutGlissement. |
||||||||||
Remarques :
Cette méthode n'est pas mise en oeuvre par le générateur Java.
Elle n'est pas disponible en génération Mobile.
GD_LIRE_DONNEES
Cette méthode permet de lire les données qui sont transmises dans l'opération de glisser-déposer en cours. Ces données sont une copie des données écrites dans l'objet source par la méthode GD_ECRIRE_DONNEES.
Cette méthode doit être utilisée en boucle pour parcourir toutes les données d'un type Adélia donné.
Toutes les données d'un type sont lues lorsque le nombre de données lues est strictement inférieur au nombre de données à lire.
Remarques :
L'appel de cette méthode avec un tableau Adélia de n éléments est équivalent à n appels de cette méthode avec une variable Adélia.
Si la méthode GD_ECRIRE_DONNEES a été utilisée pour écrire n enregistrements dont chacun contient deux variables de type ALPHA, la méthode GD_LIRE_DONNEES doit être utilisée deux fois avec les indices (2n - 1) et 2n pour récupérer les chaînes du énième enregistrement, ou une fois avec l'indice (2n-1) et un tableau recevant 2 données.
Aucune distinction n'est faite entre les variables de type numérique étendu et condensé, quels que soient la longueur et le nombre de décimales. Les valeurs des variables de type numérique ou étendu peuvent donc être tronquées lors de la lecture. Quant aux chaînes, la lecture échoue si la taille de la variable Adélia est insuffisante pour contenir la chaîne lue.
| Syntaxe | |||||||||||||||
APPELER_METHODE NomObjetListe GD_LIRE_DONNEES Format VarAdelia Indice NbDonnees CodeRetour |
|||||||||||||||
Paramètres |
|||||||||||||||
ALPHA(50) Format (E) |
Nom du format de données recherché. | ||||||||||||||
Types possibles pour le paramètre VarAdelia (E) : ALPHA, DATE, TIME, NUM_E, NUM_P, NUM_BIN_2, NUM_BIN_4, BOOL, TIMESTAMP, IMAGE |
Variable ou tableau recevant les données. |
||||||||||||||
NUM_BIN_4 Indice (E) |
Indice de la donnée à lire pour un type donné. La première donnée possède l'indice 1. |
||||||||||||||
NUM_BIN_4 NbDonnees (E/S) |
Nombre d'informations à ajouter. Ce paramètre doit être égal à 1 pour une variable, et doit être inférieur ou égal au nombre d'éléments du tableau pour un tableau. Après appel de la méthode, il contient le nombre d'informations écrites. |
||||||||||||||
NUM_BIN_4 CodeRetour (S) |
Code de retour de l'opération.
Valeurs possibles :
|
||||||||||||||
Conditions d'utilisation |
La méthode ne peut être utilisée que sur les événements GD_EntreeGlissement, GD_SurvolGlissement et GD_Depose. |
||||||||||||||
Remarques :
Cette méthode n'est pas mise en oeuvre par le générateur Java.
Elle n'est pas disponible en génération Mobile.
GD_VIDER_DONNEES
Cette méthode efface les données stockées dans l'objet qui seraient utilisées dans une opération de glisser-déposer.
Ces données ont été créées auparavant par la méthode GD_ECRIRE_DONNEES.
| Syntaxe | |||
APPELER_METHODE NomObjetListe GD_VIDER_DONNEES CodeRetour |
|||
Paramètres |
|||
NUM_BIN_4 CodeRetour (S) |
Code de retour de l'opération.
Valeurs possibles :
|
||
Conditions d'utilisation |
Aucune |
||
Remarques :
Cette méthode n'est pas mise en oeuvre par le générateur Java.
Elle n'est pas disponible en génération Mobile.
INITIALISER_CHAMPS_FILTRES
Positionne le champ filtre à "*" et remet à blanc la propriété VALEUR_INTERNE_FILTRE pour toutes les colonnes de la liste.
| Syntaxe | |||||
APPELER_METHODE NomObjetListe INITIALISER_CHAMPS_FILTRES CodeRetour |
|||||
Paramètres |
|||||
NUM_BIN_4 CodeRetour (S) |
Code de retour de l'opération.
Valeurs possibles :
|
||||
Conditions d'utilisation |
Aucune |
||||
METTRE_FOCUS
Met le focus sur l'objet.
Syntaxe |
|
APPELER_METHODE NomObjetListe METTRE_FOCUS |
|
Conditions d'utilisation |
Aucune |
RAFRAICHIR_COLONNES
Autorise l'objet à effectuer les traitements internes nécessaires lors de la mise à jour d'une propriété ou l'appel d'une méthode de l'objet LISTE ou de l'objet COLONNE.
L'utilisateur peut empêcher le traitement interne de s'effectuer autant de fois qu'il y a de propriétés à mettre à jour en plaçant les instructions entre deux appels à cette méthode. Le traitement ne s'effectuera alors qu'une seule fois.
Les propriétés de l'objet COLONNE concernées sont :
LARGEUR
VISIBILITE
EN_TETE_POLICE
FILTRE
TEXTE
ALIGNEMENT
INDICATEUR_TRI
Les propriétés de l'objet LISTE concernées sont :
ABSCISSE
ORDONNEE
LARGEUR
HAUTEUR_ENTETE
PAG_DYN_AVANT et PAG_DYN_ARRIERE si au moins une colonne a la propriété FILTRE égale à _COL_FILTRE_AUTOMATIQUE_LISTE_COMPLETE
Les méthodes de l'objet COLONNE concernées sont :
FIXER_NUMERO_ORDRE
INITIALISER_CHAMP_FILTRE
Remarque : le déplacement d'une colonne via l'interface entraîne également un rafraîchissement des colonnes.
La méthode de l'objet LISTE concernée est :
INITIALISER_CHAMPS_FILTRES
| Syntaxe | |
APPELER_METHODE NomObjetListe RAFRAICHIR_COLONNES FlagRafraichissementAuto |
|
Paramètres |
|
BOOL FlagRafraichissementAuto |
Si le paramètre FlagRafraichissementAuto est *VRAI, le rafraîchissement des colonnes se fait immédiatement et les prochaines modifications de propriétés entraîneront systématiquement un rafraîchissement (comportement par défaut). Sinon, le rafraîchissement est bloqué jusqu'au prochain appel de la fonction avec le FlagRafraîchissementAuto à *VRAI. |
Conditions d'utilisation |
Aucune |
Remarque : cette méthode n'est mise en oeuvre ni par le générateur Java, ni par le générateur Mobile.
Exemple
APPELER_METHODE FEN_PERSO.LST_PERSO RAFRAICHIR_COLONNES *FAUX
FEN_PERSO.COL1:VISIBILITE = *FAUX
FEN_PERSO. COL1:VISIBILITE = *VRAI
FEN_PERSO. COL1:TEXTE = 'COL CHG'
FEN_PERSO. COL1:LARGEUR = 25
FEN_PERSO. COL1:EN_TETE_ALIGNEMENT = _COL_ALIGN_DROITE
FEN_PERSO. COL1:EN_TETE_POLICE = 'MS SANS SERIF;14;1;1'
FEN_PERSO. COL2:VISIBILITE = *FAUX
FEN_PERSO. COL2:VISIBILITE = *VRAI
FEN_PERSO. COL2:TEXTE = 'COL CHG'
FEN_PERSO. COL2:LARGEUR = 25
FEN_PERSO. COL2:EN_TETE_ALIGNEMENT = _COL_ALIGN_DROITE
FEN_PERSO. COL2:EN_TETE_POLICE = 'MS SANS SERIF;14;1;1'
APPELER_METHODE FEN_PERSO.LST_PERSO RAFRAICHIR_COLONNES *VRAI
Attention : Il est important de refixer le rafraîchissement à *Vrai au risque de se trouver dans un état erroné.
RAFRAICHIR_LISTE
Autorise l'objet à se redessiner. L'utilisateur peut ainsi figer l'affichage de l'objet entre deux appels à cette méthode.
| Syntaxe | |
APPELER_METHODE NomObjetListe RAFRAICHIR_LISTE FlagRafraichissementAuto |
|
Paramètres |
|
BOOL FlagRafraichissementAuto |
Si le paramètre FlagRafraichissementAuto est *VRAI, le rafraîchissement graphique se fait dès que nécessaire. Sinon, le rafraîchissement est bloqué jusqu'au prochain appel de la fonction avec le FlagRafraîchissementAuto à *VRAI. |
Conditions d'utilisation |
Aucune |
Remarque : cette méthode n'est pas mise en oeuvre par le générateur Java.
Exemple
VIDER_LST FEN_PERSO.LST_PERSO:LISTE
* Optimisation par la méthode RAFRAICHIR_LISTE.
* En effet, si à l'exécution cette méthode n'est pas à Faux avant le
* chargement de la liste, celle-ci est rafraîchie à
* chaque insertion d'élément.
Rafraich = *FAUX
APPELER_METHODE FEN_PERSO.LST_PERSO RAFRAICHIR_LISTE -
Rafraich
* Chargement de la liste.
TRAITER_PROC CHARGE_LISTE
Rafraich = *VRAI
APPELER_METHODE FEN_PERSO.LST_PERSO RAFRAICHIR_LISTE -
Rafraich
*
RECUPERER_COLONNES
Récupère dans un tableau le nom des colonnes de la liste graphique.
Le tableau est trié selon l'ordre des colonnes de la liste graphique.
| Syntaxe | |||||
APPELER_METHODE NomObjetListe RECUPERER_COLONNES TableauNomColonnes Taille NombreElementsLus CodeRetour |
|||||
Paramètres |
|||||
ALPHA(128) TableauNomColonnes (S) |
Tableau recevant en sortie le nom des colonnes présentes dans la liste graphique. |
||||
NUM_BIN_4 Taille (E) |
Taille du tableau TableauNomColonnes. |
||||
NUM_BIN_4 NombreElementsLus (S) |
Nombre d'éléments insérés dans le tableau. |
||||
NUM_BIN_2 CodeRetour (S) |
Code retour de l'opération.
Valeurs possibles :
|
||||
Remarques :
La longueur du tableau TableauNomColonnes doit être au moins égale à la taille indiquée.
S'il y a plus de colonnes que la taille indiquée, le code retour aura la valeur -1 mais le tableau sera bien rempli.
Exemple d'utilisation : Les noms d'objets récupérés peuvent être utilisés par la fonction prédéfinie &RECUPERER_OBJET afin de manipuler les propriétés des objets.
Remarque : cette méthode n'est pas mise en oeuvre en génération Java.
RECUPERER_COLONNES_FIGEES
Récupère le nombre d'objets COLONNE figés lors d'un appel à la méthode FIXER_COLONNES_FIGEES.
| Syntaxe | |||||||
APPELER_METHODE NomObjetListe RECUPERER_COLONNES_FIGEES NbColonnes CodeRetour |
|||||||
Paramètres |
|||||||
NUM_BIN_4 NbColonnes |
Nombre de colonnes figées. Ce nombre prend en compte les colonnes non visibles. |
||||||
NUM_BIN_2 CodeRetour |
Code retour de l'opération.
Valeurs possibles :
|
||||||
Conditions d'utilisation |
Aucune |
||||||
Remarque : cette méthode n'est pas mise en oeuvre par le générateur Java.
RECUPERER_COORDONNEES_CELLULE
Remarque : cette méthode n'est pas mise en oeuvre par le générateur Java.
Récupère le numéro de ligne et de colonne de la cellule qui se trouve à la position donnée au moment de l'appel de cette méthode. La position est un couple de valeurs en pixels relative au coin supérieur gauche de la liste.
Si la position correspond à une cellule ou à un en-tête, le booléen CelluleTrouvee est à *VRAI.
Si la position correspond à un point situé sur le bord ou sur le fond de la liste, le booléen est à *FAUX.
| Syntaxe | |
APPELER_METHODE NomObjetListe RECUPERER_COORDONNEES_CELLULE Abscisse Ordonnee NumLigne NumColonne CelluleTrouvee |
|
Paramètres |
|
NUM_BIN_4 Abscisse (E) |
Abscisse du point relative au coin supérieur gauche de la liste. |
NUM_BIN_4 Ordonnee (E) |
Ordonnée du point relative au coin supérieur gauche de la liste. |
NUM_BIN_4 NumLigne (S) |
Numéro de ligne de la cellule se trouvant à la position donnée. Valeurs possibles :
|
NUM_BIN_4 NumColonne (S) |
Numéro de colonne de la cellule se trouvant à la position donnée. Valeurs possibles :
|
BOOL CelluleTrouvee (S) |
La valeur est à *VRAI si une cellule ou un en-tête se trouve à la position donnée, *FAUX dans le cas contraire. |
Conditions d'utilisation |
Aucune |
RECUPERER_HAUTEUR_LIGNE
Retourne la hauteur de la ligne passée en paramètre.
| Syntaxe | |
APPELER_METHODE NomObjetListe RECUPERER_HAUTEUR_LIGNE NumLigne Hauteur CodeRetour |
|
Paramètres |
|
NUM_BIN_4 NumLigne (E) |
Numéro de la ligne. |
NUM_BIN_4 Hauteur (S) |
Reçoit la hauteur de la ligne NumLigne. |
BOOL CodeRetour (S) |
*VRAI : opération réussie. *FAUX : échec (NumLigne ne correspond à aucune ligne). |
Conditions d'utilisation |
Aucune |
RECUPERER_MODE_EXECUTION
Retourne le mode courant (sélection ou saisie) de l'objet ainsi que son état.
| Syntaxe | |||||
APPELER_METHODE NomObjetListe RECUPERER_MODE_EXECUTION Mode EtatMode CodeRetour |
|||||
Paramètres |
|||||
NUM_BIN_2 Mode |
Mode résultat de l'objet.
Valeurs possibles :
|
||||
BOOL EtatMode |
Etat résultat du mode de l'objet. La valeur est à *VRAI si le mode est dans un état persistant (c'est-à-dire non modifiable via l'interface), et *FAUX sinon. |
||||
NUM_BIN_2 CodeRetour |
Code retour de l'opération.
Valeurs possibles :
|
||||
Conditions d'utilisation |
Aucune
Valeurs possibles :
|
||||
RECUPERER_PROPRIETES_COLONNES
Récupère les propriétés des objets COLONNE constituant la liste avec les valeurs des propriétés de la ligne dont le numéro est indiqué dans NumLigne .
Les propriétés de l'objet COLONNE mises à jour sont : ALIGNEMENT, COULEUR_FOND, COULEUR_TEXTE, INVERSION_IMAGE, LECTURE_SEULE, VALEUR et POLICE.
| Syntaxe | |
APPELER_METHODE NomObjetListe RECUPERER_PROPRIETES_COLONNES NumLigne CodeRetour |
|
Paramètres |
|
NUM_BIN_4 NumLigne |
Numéro de la ligne. Si NumLigne vaut 0, il prend la valeur de la propriété NUMERO_LIGNE_COURANTE (rang de la dernière ligne active). |
BOOL CodeRetour |
Code retour de l'opération. Le paramètre CodeRetour vaut *VRAI si l'opération s'est bien effectuée. Dans le cas contraire, il vaut *FAUX (dans le cas où NumLigne ne correspond à aucune ligne). |
Conditions d'utilisation |
Aucune |
RECUPERER_TOUCHES_EVT_SOURIS
Permet de récupérer les touches du clavier qui ont été définies lors du précédent appel à la méthode FIXER_TOUCHE_EVT_SOURIS et qui étaient dans l'état "enfoncé" lors du dernier événement 'MouvementSouris' sur l'objet Liste.
| Syntaxe | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
APPELER_METHODE NomObjetListe RECUPERER_TOUCHES_EVT_SOURIS EtatToucheMaj EtatToucheCtrl EtatToucheAlt TabAlphaNum TabAutresTouches TailleTabAutresTouches CodeRetour |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Paramètres |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BOOL EtatToucheMaj (S) |
Rend *Vrai si la touche clavier Maj était dans l'état "enfoncé" lors du dernier événement souris sur l'objet Liste. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BOOL EtatToucheCtrl (S) |
Rend *Vrai si la touche clavier Ctrl était dans l'état "enfoncé" lors du dernier événement souris sur l'objet Liste. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BOOL EtatToucheAlt (S) |
Rend *Vrai si la touche clavier Alt était dans l'état "enfoncé" lors du dernier événement souris sur l'objet Liste. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ALPHA(36) AlphaNum (S) |
Variable alphanumérique contenant les touches alphanumériques de A à Z et les touches numériques de 0 à 9 qui étaient dans l'état "enfoncé" lors du dernier événement souris sur l'objet Liste. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Tableau de NUM_BIN2 TabAutresTouches (S) |
Tableau contenant les autres touches du clavier qui étaient dans l'état "enfoncé" lors du dernier événement souris sur l'objet Liste. Les valeurs correspondant aux touches sont indiquées dans la méthode FIXER_TOUCHES_EVT_SOURIS.
Valeurs possibles :
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NUM_BIN2 TailleTabAutresTouches (E/S) |
En entrée : taille du tableau TabAutresTouches. En sortie : nombre de touches à l'état enfoncé récupérées dans le tableau TabAutresTouches. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NUM_BIN_2 CodeRetour (S) |
Code de retour de l'opération.
Valeurs possibles :
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Conditions d'utilisation |
Aucune |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
La longueur du tableau TabAutresTouches doit être au moins égale à la taille indiquée.
La valeur des paramètres EtatToucheMaj et EtatToucheCtr est fixée à *Vrai lorsque respectivement les touches Maj gauche ou droite et Ctrl gauche ou droite sont dans l'état "enfoncé".
Il est possible de différencier les touches gauche et droite en utilisant les valeurs _LST_TOUCHE_CLAVIER_MAJ_G et _LST_TOUCHE_CLAVIER_MAJ_D pour la touche Maj et _LST_TOUCHE_CLAVIER_CTRL_G et _LST_TOUCHE_CLAVIER_CTRL_D pour la touche Ctrl dans le paramètre TabAutresTouches.
Si la touche Alt Gr est dans l'état "enfoncé", la valeur des paramètres EtatToucheAlt et EtatToucheCtr est fixée à *Vrai.
Remarque : cette méthode n'est mise en œuvre ni en génération Java ni en génération Mobile.
RECUPERER_VALEUR_COLONNES
Récupère la propriété VALEUR des objets COLONNE constituant la liste avec les valeurs de la ligne dont le numéro est indiqué dans NumLigne .
| Syntaxe | |
APPELER_METHODE NomObjetListe RECUPERER_VALEUR_COLONNES NumLigne CodeRetour |
|
Paramètres |
|
NumLigne |
Type NUM_BIN_4. Si NumLigne vaut 0, il prend la valeur de la propriété NUMERO_LIGNE_COURANTE (rang de la dernière ligne active). |
CodeRetour |
Type BOOL. Le paramètre CodeRetour vaut *VRAI si l'opération s'est bien effectuée. Dans le cas contraire, il vaut *FAUX (dans le cas où NumLigne ne correspond à aucune ligne). |
Conditions d'utilisation |
Aucune |
SUPPRIMER_IMAGE
Supprime une image dans la liste d'images de l'objet.
| Syntaxe | |||||
APPELER_METHODE NomObjetListe SUPPRIMER_IMAGE NumImage CodeRetour |
|||||
Paramètres |
|||||
NUM_BIN_4 NumImage |
Numéro de l'image à supprimer (voir méthode AJOUTER_IMAGE). La constante _LST_TOUTES_IMAGES permet de supprimer toutes les images de la liste. |
||||
BOOL CodeRetour |
Code retour de l'opération.
Valeurs possibles :
|
||||
Conditions d'utilisation |
Aucune |
||||
Remarque : cette méthode n'est pas mise en oeuvre par le générateur Java.
Voir aussi...