- arborescence
- gd_lire_donnees
- gd_vider_donnees
- gd_donnees_disponibles
- gd_ecrire_donnees
- gd_executer_glissement
- mettre_focus
- ajouter_image
- ajouter
- recuperer_nb_fils
- recuperer_image
- recuperer_position_curseur
- recuperer_parent
- recuperer_profondeur
- recuperer_precedent
- recuperer_texte
- recuperer_suivant
- recuperer_case_a_cocher
- parcourir
- recuperer_couleur_texte
- recuperer_couleur_fond
- recuperer_drag_drop
- recuperer_description
- recuperer_fils
- recuperer_edition
- fixer_description
- fixer_couleur_texte
- fixer_edition
- fixer_drag_drop
- fixer_position_curseur
- fixer_image
- fixer_variable_associee
- fixer_texte
- coller
- ajouter_image_url
- couper
- copier
- expanser
- est_descendant
- fixer_couleur_fond
- fixer_case_a_cocher
- supprimer
- recuperer_variable_associee
- trier
Sens affectés aux paramètres des méthodes :
(E) |
Entrée, |
(S) |
Sortie, |
(E/S) |
Entrée et Sortie. |
AJOUTER
Ajoute un élément à l'arborescence.
| Syntaxe | |
APPELER_METHODE NomObjetArborescence AJOUTER IdParent Position Texte VariableAssociee LgVariableAssociee IdDescription IdElement CodeRetour |
|
| Paramètres | |
NUM_BIN_4 IdParent |
Identifiant de l'élément parent (père ou frère) (paramètre en entrée). |
NUM_BIN_2 Position |
Position d'ajout du nouvel élément (paramètre en entrée). |
ALPHA(250) Texte |
Texte de l'élément (paramètre en entrée). |
Nom de VariableAssociee |
Information associée à l'élément. Variable de type Adélia quelconque à l'exception des types LISTE, IMAGE, POINTEUR *IDISPATCH et POINTEUR *IUNKNOWN. Les tableaux de types autorisés sont admis. Ce paramètre peut être omis en mettant *AUCUN à sa place (paramètre en entrée). |
NUM_BIN_4 LgVariableAssociee |
Paramètre non utilisé depuis la PTF 06 de la version 8.2. Indiquer : *AUCUN. |
NUM_BIN_2 IdDescription |
Identifiant représentant le type Adélia de la variable associée (utilisé pour savoir quel doit être le type Adélia du paramètre VariableAssociee lors de l'appel de la méthode RECUPERER_VARIABLE_ASSOCIEE. Cet identifiant propre à l'utilisateur est mis en oeuvre dans la méthode RECUPERER_DESCRIPTION). Ce paramètre peut être omis en mettant *AUCUN à sa place (seulement si VariableAssociee vaut *AUCUN) (paramètre en entrée). |
NUM_BIN_4 IdElement |
Identifiant du nouvel élément ajouté. Ce paramètre peut être omis en mettant *AUCUN à sa place (paramètre en sortie). |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
| Valeurs possibles de IdParent | |
_ARB_RACINE |
Racine de l'arbre. |
une valeur de type NUM_BIN_4 |
Elément unique. Cette valeur est donnée lors d'appels de méthodes ou d'accès aux valeurs de propriétés retournant un identifiant d'élément valide (par exemple les méthodes AJOUTER, RECUPERER_PARENT ou les propriétés ELEMENT_SELECTIONNE, ELEMENT_ACTION). |
| Valeurs possibles de la position | |
_ARB_POS_AVANT |
IdParent représente un élément frère (il ne peut pas prendre la valeur _ARB_RACINE). L'élément créé est ajouté avant IdParent , |
_ARB_POS_APRES |
IdParent représente un élément frère (il ne peut pas prendre la valeur _ARB_RACINE). L'élément créé est ajouté après IdParent , |
_ARB_POS_DEBUT |
IdParent représente un élément père. L'élément créé est ajouté en tête des fils de IdParent , |
_ARB_POS_FIN |
IdParent représente un élément père. L'élément créé est ajouté en fin des fils de IdParent . |
| Valeurs possibles du code retour | |
-7 |
Le type Adélia de la variable associée n'est pas autorisé, |
-6 |
La valeur du paramètre IdDescription est incorrecte, |
-5 |
Les valeurs des propriétés LONGUEUR_TYPE et / ou NB_DECIMALES_TYPE sont incompatibles avec la valeur de la propriété CONTROLE_SAISIE, |
-4 |
Erreur lors de la création de l'élément, |
-3 |
La valeur du paramètre LgVariableAssociee est incorrecte, |
-2 |
La valeur du paramètre IdParent est incorrecte, |
-1 |
La valeur du paramètre Position est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
| Conditions d'utilisation | S'il existe une liste d'images associée à l'objet (créé lors du premier appel à la méthode AJOUTER_IMAGE), alors l'élément créé a pour image par défaut celle d'indice 0 dans la liste d'images. |
AJOUTER_IMAGE
Ajoute une image à la liste d'images associée à l'objet.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence AJOUTER_IMAGE InfoImage IdImage CodeRetour
|
|
Paramètres |
|
ALPHA(250) ou IMAGE InfoImage |
Image à ajouter à la liste d'images. Le paramètre peut être une variable alphanumérique contenant le nom et répertoire du fichier qui contient l'image.Les formats admis pour le fichier 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. Le paramètre peut être également une variable de type IMAGE. Le contenu de la variable est alors 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 (paramètre en entrée), |
NUM_BIN_4 IdImage |
Identifiant de l'image nouvellement ajoutée (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
| Valeurs possibles du code retour | |
-2 |
Erreur lors de la lecture du fichier image, |
-1 |
Erreur lors de l'ajout de l'image, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
S'il existe une liste d'images associée à l'objet (créée lors du premier appel à la méthode AJOUTER_IMAGE), alors l'élément créé a pour image par défaut celle d'indice 0 dans la liste d'images. |
AJOUTER_IMAGE_URL
Ajoute une image à la liste d'images associée à l'objet.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence AJOUTER_IMAGE_URL AdresseUrl IdImage 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 IdImage |
Identifiant de l'image nouvellement ajoutée (paramètre en sortie). |
NUM_BIN_4 CodeRetour |
Code retour de l'opération (paramètre en sortie). Valeurs possibles du CodeRetour : -2 : Erreur lors de la lecture du fichier image -1 : Erreur lors de l'ajout de l'image 0 : Erreur interne 1 : Opération correctement effectuée > 1 : Erreur lors de l'exécution de la requête http Attention : la valeur du code retour n'a aucune signification en génération Cloud. |
| Conditions d'utilisation | S'il existe une liste d'images associée à l'objet (créée lors du premier appel à la méthode AJOUTER_IMAGE ou AJOUTER_IMAGE_URL), alors l'élément créé a pour image par défaut celle d'indice 0 dans la liste d'images. |
Remarque : cette méthode n'est mise en oeuvre ni par le générateur Java, ni par le générateur Mobile.
COLLER
Colle un arbre (précédemment copié par appel à la méthode COPIER ou COUPER) à une position donnée.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence COLLER IdParent Position CodeRetour |
|
| Paramètres | |
NUM_BIN_4 IdParent |
Identifiant de l'élément parent (père ou frère) (paramètre en entrée), |
NUM_BIN_2 Position |
Position d'ajout du nouvel élément (paramètre en entrée), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
| Valeurs possibles de la position | |
_ARB_POS_AVANT |
IdParent représente un élément frère (il ne peut pas prendre la valeur _ARB_RACINE). L'élément créé est ajouté avant IdParent , |
_ARB_POS_APRES |
IdParent représente un élément frère (il ne peut pas prendre la valeur _ARB_RACINE). L'élément créé est ajouté après IdParent , |
_ARB_POS_DEBUT |
IdParent représente un élément père. L'élément créé est ajouté en tête des fils de IdParent , |
_ARB_POS_FIN |
IdParent représente un élément père. L'élément créé est ajouté en fin des fils de IdParent . |
| Valeurs possibles du code retour | |
-3 |
La valeur du paramètre IdParent est incorrecte, |
-2 |
La valeur du paramètre Position est incorrecte, |
-1 |
Il n'y a aucun arbre copié précédemment, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
| Conditions d'utilisation | L'appel à la méthode COPIER (ou COUPER) détruit la copie de l'arbre copié précédemment (s'il existe). |
COPIER
Copie l'arbre dont la racine est un élément donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence COPIER IdElement CodeRetour |
|
| Paramètres | |
NUM_BIN_4 IdElement |
Identifiant de l'élément racine (paramètre en entrée), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-2 |
L'arbre à copier est vide, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
L'appel à la méthode COPIER (ou COUPER) détruit la copie de l'arbre copié précédemment (s'il existe). |
COUPER
Copie l'arbre dont la racine est un élément donné puis le supprime.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence COUPER IdElement CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément racine (paramètre en entrée), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-2 |
L'arbre à couper est vide, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
L'appel à la méthode COPIER (ou COUPER) détruit la copie de l'arbre copié précédemment (s'il existe). |
EST_DESCENDANT
Teste s'il existe un lien de descendance entre deux éléments.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence EST_DESCENDANT IdElementPere IdElementFils EstDescendant CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElementPere |
Identifiant de l'élément père (paramètre en entrée), |
NUM_BIN_4 IdElementFils |
Identifiant de l'élément fils (paramètre en entrée), |
BOOL EstDescendant |
*VRAI si IdElementFils est un descendant de IdElementPere , FAUX sinon (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-2 |
La valeur du paramètre IdElementPere est incorrecte, |
-1 |
La valeur du paramètre IdElementFils est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
EXPANSER
Expanse ou réduit un élément noeud donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence EXPANSER IdElement Expanse CodeRetour
|
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
BOOL Expanse |
*VRAI pour expanser, *FAUX pour réduire (paramètre en entrée), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-2 |
Erreur lors de l'expansion / réduction de l'élément, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
FIXER_CASE_A_COCHER
Fixe l'état de la case à cocher associée à un élément donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence FIXER_CASE_A_COCHER IdElement Coche CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
BOOL Coche |
Etat de la case à cocher (*VRAI si elle est cochée, *FAUX sinon) (paramètre en entrée), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-3 |
La propriété CASE_A_COCHER n'a pas la valeur *VRAI, |
-2 |
Erreur lors de la fixation de l'état de la case à cocher de l'élément, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
La propriété CASE_A_COCHER doit avoir la valeur *VRAI. |
FIXER_COULEUR_FOND
Fixe la couleur RVB d'arrière plan du texte d'un élément donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence FIXER_COULEUR_FOND IdElement Couleur CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
NUM_BIN_4 Couleur |
Couleur RVB du fond (paramètre en entrée), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs prédéfinies de la couleur |
|
_ARB_COUL_SYSTEME |
couleur système, |
_ARB_COUL_NOIR |
couleur noir, |
_ARB_COUL_BLEU |
couleur bleu, |
_ARB_COUL_CYAN |
couleur cyan, |
_ARB_COUL_VERT |
couleur vert, |
_ARB_COUL_MAGENTA |
couleur magenta, |
_ARB_COUL_ROUGE |
couleur rouge, |
_ARB_COUL_BLANC |
couleur blanc, |
_ARB_COUL_JAUNE |
couleur jaune, |
_ARB_COUL_BLEUFONCE |
couleur bleu foncé, |
_ARB_COUL_CYANFONCE |
couleur cyan foncé, |
_ARB_COUL_VERTFONCE |
couleur vert foncé, |
_ARB_COUL_VIOLET |
couleur violet, |
_ARB_COUL_ROUGEFONCE |
couleur rouge foncé, |
_ARB_COUL_JAUNEFONCE |
couleur jaune foncé, |
_ARB_COUL_GRIS |
couleur gris, |
_ARB_COUL_GRISFONCE |
couleur gris foncé. |
Valeurs possibles du code retour |
|
-2 |
Erreur lors de la fixation de la couleur du fond, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
FIXER_COULEUR_TEXTE
Fixe la couleur RVB du texte d'un élément donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence FIXER_COULEUR_TEXTE IdElement Couleur CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
NUM_BIN_4 Couleur |
Couleur RVB du texte (paramètre en entrée), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs prédéfinies de la couleur |
|
_ARB_COUL_SYSTEME |
couleur système, |
_ARB_COUL_NOIR |
couleur noir, |
_ARB_COUL_BLEU |
couleur bleu, |
_ARB_COUL_CYAN |
couleur cyan, |
_ARB_COUL_VERT |
couleur vert, |
_ARB_COUL_MAGENTA |
couleur magenta, |
_ARB_COUL_ROUGE |
couleur rouge, |
_ARB_COUL_BLANC |
couleur blanc, |
_ARB_COUL_JAUNE |
couleur jaune, |
_ARB_COUL_BLEUFONCE |
couleur bleu foncé, |
_ARB_COUL_CYANFONCE |
couleur cyan foncé, |
_ARB_COUL_VERTFONCE |
couleur vert foncé, |
_ARB_COUL_VIOLET |
couleur violet, |
_ARB_COUL_ROUGEFONCE |
couleur rouge foncé, |
_ARB_COUL_JAUNEFONCE |
couleur jaune foncé, |
_ARB_COUL_GRIS |
couleur gris, |
_ARB_COUL_GRISFONCE |
couleur gris foncé. |
Valeurs possibles du code retour |
|
-2 |
Erreur lors de la fixation de la couleur du texte, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
FIXER_DESCRIPTION
Fixe la valeur de l'identifiant de description de la variable associée d'un élément donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence FIXER_DESCRIPTION IdElement IdDescription CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
NUM_BIN_2 IdDescription |
Description correspondant à la variable associée de l'élément (paramètre en entrée), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-2 |
Erreur lors de la fixation de la variable associée de l'élément, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
FIXER_DRAG_DROP
Fixe l'autorisation de drag and drop d'un élément donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence FIXER_DRAG_DROP IdElement DragDrop CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
BOOL DragDrop |
*VRAI pour autoriser le drag and drop, *FAUX sinon (paramètre en entrée), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-2 |
Erreur lors de la fixation de l'autorisation de drag and drop, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
FIXER_EDITION
Fixe l'autorisation de saisie du texte d'un élément donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence FIXER_EDITION IdElement Edition CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
BOOL Edition |
*VRAI pour autoriser la saisie, *FAUX sinon (paramètre en entrée), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-2 |
Erreur lors de la fixation de l'autorisation de saisie, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
FIXER_IMAGE
Fixe une image associée à un état particulier d'un élément donné. L'image apparaîtra à la gauche du texte de l'élément lorsque celui-ci se trouvera dans l'état spécifié.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence FIXER_IMAGE IdElement IdImage Etat CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
NUM_BIN_4 IdImage |
Identifiant de l'image associée à l'élément (paramètre en entrée), |
NUM_BIN_2 Etat |
Etat de l'élément (paramètre en entrée), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
| Valeurs possibles du paramètre Etat | |
_ARB_ETAT_SELECTIONNE |
L'élément est sélectionné, |
_ARB_ETAT_NON_SELECTIONNE |
L'élément n'est pas sélectionné, |
_ARB_ETAT_REDUIT |
L'élément est réduit, |
_ARB_ETAT_EXPANSE |
L'élément est expansé, |
_ARB_TOUS_ETATS |
Regroupe les états précédemment cités. |
| L'ordre de priorité des états (par ordre croissant) pour un élément est le suivant : | |
_ARB_ETAT_NON_SELECTIONNE, _ARB_ETAT_EXPANSE, _ARB_ETAT_REDUIT, _ARB_ETAT_SELECTIONNE. |
|
| Valeurs possibles du code retour | |
-4 |
La valeur du paramètre Etat est incorrecte, |
-3 |
Erreur lors de la fixation de l'image, |
-2 |
La valeur du paramètre IdElement est incorrecte, |
-1 |
La valeur du paramètre IdImage est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
FIXER_POSITION_CURSEUR
Sélectionne un bloc de caractères dans le champ de saisie de l'élément.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence FIXER_POSITION_CURSEUR IdElement PositionDebut PositionFin CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée). |
NUM_BIN_4 PositionDebut |
Position du premier caractère à sélectionner (paramètre en entrée). Si PositionDebut vaut –1 le texte n'est plus sélectionné et le curseur se positionne en fin de ligne. |
NUM_BIN_4 PositionFin |
Position du premier caractère après le dernier caractère à sélectionner (paramètre en entrée). Si PositionFin vaut –1 le texte est entièrement sélectionné. |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
| Valeurs possibles du code retour | |
-2 |
Impossible de rentrer en mode saisie sur l'élément, |
-1 |
L'identifiant de l'élément passé en paramètre est invalide, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
Remarque : cette méthode n'est pas mise en oeuvre par le générateur Java.
FIXER_TEXTE
Fixe le texte associé à un élément.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence FIXER_TEXTE IdElement Texte CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
ALPHA(250) Texte |
Texte de l'élément à fixer (paramètre en entrée), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-2 |
Erreur lors de la fixation du texte de l'élément, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
FIXER_VARIABLE_ASSOCIEE
Syntaxe |
||
APPELER_METHODE NomObjetArborescence FIXER_VARIABLE_ASSOCIEE IdElement VariableAssociee LgVariableAssociee CodeRetour |
||
Paramètres |
|
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée). |
|
Nom de VariableAssociee |
Information associée à l'élément. Variable de type Adélia quelconque à l'exception des types LISTE, IMAGE, POINTEUR *IDISPATCH et POINTEUR *IUNKNOWN. Les tableaux de types autorisés sont admis. |
|
NUM_BIN_4 LgVariableAssociee |
Paramètre non utilisé depuis la PTF 06 de la version 8.2. Indiquer : *AUCUN. |
|
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
|
Valeurs possibles du code retour |
|
|
-4 |
La valeur du paramètre VariableAssociee est incorrecte, |
|
-3 |
La valeur du paramètre LgVariableAssociee est incorrecte, |
|
-2 |
Erreur lors de la fixation de la variable associée de l'élément, |
|
-1 |
La valeur du paramètre IdElement est incorrecte, |
|
0 |
Erreur interne, |
|
1 |
Opération correctement effectuée. |
|
Conditions d'utilisation |
Veiller à ce que le type Adélia de la nouvelle variable associée soit toujours en correspondance avec la valeur de l'identifiant de description. Si ce n'est plus le cas, changer de valeur d'identifiant avec la méthode FIXER_DESCRIPTION. |
|
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 NomObjetArborescence GD_DONNEES_DISPONIBLES Format Disponibilite CodeRetour |
|
Paramètres |
|
ALPHA(50) Format (E) |
Nom du format de données recherché. |
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 du paramètre Format |
|
_CF_TEXT |
Format pour une donnée de type texte au format ANSI. |
_CF_OEMTEXT |
Format pour une donnée de type texte au format OEM. |
_CF_UNICODETEXT |
Format pour une donnée de type texte au format UNICODE. |
_CF_DIB |
Format pour une donnée de type DIB (Device Independant Bitmap). |
| Une chaîne quelconque qui ne commence pas par "CF_" pour un format défini par le développeur. | |
Valeurs possibles du code retour |
|
_ERR_OK |
L'exécution de la méthode s'est déroulée correctement. |
_ERR_CTX_UTILISATION |
La méthode est utilisée en dehors d'un événement autorisé pour cette méthode. |
_ERR_FORMAT_INVALIDE |
Le nom de format passé en paramètre ne correspond à aucune donnée ou est invalide. |
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 NomObjetArborescence GD_ECRIRE_DONNEES VarAdelia NbDonnees CodeRetour |
|
Paramètres |
|
Types possibles pour le paramètre VarAdelia (E) : |
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 du code retour |
|
_ERR_OK |
L'exécution de la méthode s'est déroulée correctement. |
_ERR_TYPE_INVALIDE |
Une variable utilisée dans la méthode ne possède pas un type Adélia adéquat. |
_ERR_PARAM_INVALIDE |
La valeur d'au moins un paramètre de la méthode est invalide. |
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 NomObjetArborescence GD_EXECUTER_GLISSEMENT Format ActionsPermises ActionFaite CodeRetour |
|
Paramètres |
|
ALPHA(50) Format (E) |
Nom du format de données. |
NUM_BIN_4 ActionsPermises (E) |
Actions permises dans l'objet cible. |
NUM_BIN_4 ActionFaite (S) |
Action effectuée dans l'objet cible. |
NUM_BIN_4 CodeRetour (S) |
Code de retour de l'opération. |
Valeurs possibles du paramètre Format |
|
_CF_TEXT |
Format pour une donnée de type texte au format ANSI. |
_CF_OEMTEXT |
Format pour une donnée de type texte au format OEM. |
_CF_UNICODETEXT |
Format pour une donnée de type texte au format UNICODE. |
_CF_DIB |
Format pour une donnée de type DIB (Device Independant Bitmap). |
| 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. | |
Valeurs possibles du paramètre ActionsPermises |
|
_GD_ACTION_COPIE |
Les données sont copiées dans l'objet cible. |
_GD_ACTION_DEPLACEMENT |
Les données sont déplacées dans l'objet cible (et donc supprimées dans l'objet source). |
_GD_ACTION_COPIE_DEPLACE |
La somme des deux actions précédentes. |
Valeurs possibles du paramètre ActionFaite |
|
_GD_ACTION_AUCUNE |
L'utilisateur a relâché le bouton de la souris au-dessus d'un objet n'acceptant pas les données ou a annulé l'opération par la touche Echap. |
_GD_ACTION_COPIE |
Les données doivent être copiées dans l'objet cible. |
_GD_ACTION_DEPLACEMENT |
Les données doivent être déplacées dans l'objet cible (et donc supprimées dans l'objet source). |
Valeurs possibles du code retour |
|
_ERR_OK |
L'exécution de la méthode s'est déroulée correctement. |
_ERR_PARAM_INVALIDE |
La valeur d'au moins un paramètre de la méthode est invalide. |
_ERR_CTX_UTILISATION |
La méthode est utilisée en dehors d'un événement autorisé pour cette méthode. |
_ERR_AUCUNE_DONNEE |
Aucune donnée n'a été stockée pour une action de glisser-déposer. |
_ERR_FORMAT_INVALIDE |
Le nom de format passé en paramètre est invalide. |
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 NomObjetArborescence 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) : |
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 du code retour
|
|
_ERR_OK |
L'exécution de la méthode s'est déroulée correctement. |
_ERR_CTX_UTILISATION |
La méthode est utilisée en dehors d'un événement autorisé pour cette méthode. |
_ERR_TYPE_INVALIDE |
Une variable utilisée dans la méthode ne possède pas un type Adélia adéquat. |
_ERR_PARAM_INVALIDE |
La valeur d'au moins un paramètre de la méthode est invalide. |
_ERR_LG_CHAINE |
Les données à lire contiennent une chaîne de caractères dont la taille est supérieure à celle de la variable Adélia. |
_ERR_VAR_NON_DISPO |
Les données à lire ne possèdent pas d'informations du type Adélia demandé. |
_ERR_FORMAT_INVALIDE |
Le nom de format passé en paramètre ne correspond à aucune donnée ou est invalide. |
Conditions d'utilisation |
La méthode ne peut être utilisée que sur les événements GD_EntreeGlissement, GD_SurvolGlissement et GD_Depose. |
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.
APPELER_METHODE NomObjetArborescence GD_VIDER_DONNEES CodeRetour
Syntaxe |
|
APPELER_METHODE NomObjetArborescence GD_VIDER_DONNEES CodeRetour |
|
Paramètres |
|
NUM_BIN_4 CodeRetour (S) |
Code de retour de l'opération. |
Valeurs possibles du code retour |
|
_ERR_OK |
L'exécution de la méthode s'est déroulée correctement. |
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.
METTRE_FOCUS
Met le focus sur l'objet.
APPELER_METHODE NomObjetArborescence METTRE_FOCUS
Syntaxe |
|
APPELER_METHODE NomObjetArborescence METTRE_FOCUS |
|
Conditions d'utilisation |
Aucune. |
PARCOURIR
Parcourt tous les éléments d'arbre auxquels on a donné un élément racine.
APPELER_METHODE NomObjetArborescence PARCOURIR IdElement TypeParcours TabIdElement CodeRetour
Syntaxe |
||
APPELER_METHODE NomObjetArborescence PARCOURIR IdElement TypeParcours TabIdElement CodeRetour |
||
Paramètres |
||
NUM_BIN_4 IdElement |
Identifiant de l'élément racine de l'arbre (paramètre en entrée), |
|
NUM_BIN_2 TypeParcours |
Type de parcours de l'arbre (paramètre en entrée), |
|
NUM_BIN_4(n) TabIdElement |
Tableau résultat du parcours de l'arbre. Ce tableau contient les identifiants des éléments parcourus dans l'ordre défini par TypeParcours (sa taille doit être égale au nombre d'éléments de l'arbre de racine IdElement ) (paramètre en sortie), |
|
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
|
Valeurs possibles du type de parcours |
|
|
_ARB_PARCOURS_INFIXE |
L'ordre du parcours des éléments est infixe (on parcourt le sous arbre dont la racine est le premier fils de IdElement , puis on traite IdElement , puis on parcourt les sous arbres dont les racines sont les fils restants de IdElement ), |
|
_ARB_PARCOURS_PREFIXE |
L'ordre du parcours est préfixe (on traite IdElement puis on parcourt tous les sous arbres dont les racines sont les fils de IdElement ), |
|
_ARB_PARCOURS_SUFFIXE |
L'ordre du parcours est suffixe (on parcourt tous les sous arbres dont les racines sont les fils de IdElement puis on traite IdElement ). |
|
Valeurs possibles du code retour |
|
|
-2 |
La taille du tableau TabIdElement est incorrecte, |
|
-1 |
La valeur du paramètre IdElement est incorrecte, |
|
0 |
Erreur interne, |
|
1 |
Opération correctement effectuée. |
|
Conditions d'utilisation |
Aucune. |
|
RECUPERER_CASE_A_COCHER
Retourne l'état de la case à cocher associée à un élément donné.
APPELER_METHODE NomObjetArborescence RECUPERER_CASE_A_COCHER IdElement Coche CodeRetour
Syntaxe |
|
APPELER_METHODE NomObjetArborescence RECUPERER_CASE_A_COCHER IdElement Coche CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
BOOL Coche |
Etat de la case à cocher (*VRAI si elle est cochée, *FAUX sinon) (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-3 |
La propriété CASE_A_COCHER n'a pas la valeur *VRAI, |
-2 |
Erreur lors de la récupération de l'état de la case à cocher de l'élément, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
La propriété CASE_A_COCHER doit avoir la valeur *VRAI. |
RECUPERER_COULEUR_FOND
Récupère la couleur RVB d'arrière plan du texte d'un élément donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence RECUPERER_COULEUR_FOND IdElement Couleur CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
NUM_BIN_4 Couleur |
Couleur RVB du fond (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-2 |
Erreur lors de la récupération de la couleur du fond, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
RECUPERER_COULEUR_TEXTE
Récupère la couleur RVB du texte d'un élément donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence RECUPERER_COULEUR_TEXTE IdElement Couleur CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
NUM_BIN_4 Couleur |
Couleur RVB du texte (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-2 |
Erreur lors de la récupération de la couleur du texte, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
RECUPERER_DESCRIPTION
Retourne la valeur de l'identifiant de description de la variable associée d'un élément donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence RECUPERER_DESCRIPTION IdElement IdDescription CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
NUM_BIN_2 IdDescription |
Description correspondant à la variable associée de l'élément (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-3 |
Il n'y a pas d'identifiant de description associé à l'élément IdElement , |
-2 |
Erreur lors de la récupération de la variable associée de l'élément, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
RECUPERER_DRAG_DROP
Récupère l'autorisation de drag and drop d'un élément donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence RECUPERER_DRAG_DROP IdElement DragDrop CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
BOOL DragDrop |
Valeur de l'autorisation de drag and drop (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-2 |
Erreur lors de la récupération de l'autorisation de drag and drop, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
RECUPERER_EDITION
Récupère l'autorisation de saisie du texte d'un élément donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence RECUPERER_EDITION IdElement Edition CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
BOOL Edition |
Valeur de l'autorisation d'édition (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-2 |
Erreur lors de la récupération de l'autorisation de saisie, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
RECUPERER_FILS
Retourne l'élément fils d'un élément père donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence RECUPERER_FILS IdElement Premier IdElementResultat CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
BOOL Premier |
Position du fils à récupérer (*VRAI pour récupérer le premier fils, *FAUX pour récupérer le dernier fils) (paramètre en entrée), |
NUM_BIN_4 IdElementResultat |
Identifiant de l'élément fils résultat (peut avoir la valeur _ARB_AUCUN si l'élément n'a pas de fils) (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
RECUPERER_IMAGE
Récupère l'image associée à un état particulier d'un élément donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence RECUPERER_IMAGE IdElement Etat IdImage CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
NUM_BIN_4 IdImage |
Identifiant de l'image associée à l'élément (paramètre en sortie), |
NUM_BIN_2 Etat |
Etat de l'élément (paramètre en entrée), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du paramètre Etat |
|
_ARB_ETAT_SELECTIONNE |
L'élément est sélectionné, |
_ARB_ETAT_NON_SELECTIONNE |
L'élément n'est pas sélectionné, |
_ARB_ETAT_REDUIT |
L'élément est réduit, |
_ARB_ETAT_EXPANSE |
L'élément est expansé. |
Valeurs possibles du code retour |
|
-4 |
Il n'y a pas de liste d'images associée à l'objet, |
-3 |
La valeur du paramètre Etat est incorrecte, |
-2 |
Erreur lors de la récupération de l'image, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
RECUPERER_NB_FILS
Retourne le nombre d'éléments fils d'un élément noeud donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence RECUPERER_NB_FILS IdElement Nb CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
NUM_BIN_2 Nb |
Nombre de fils de l'élément (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
RECUPERER_PARENT
Retourne l'élément père d'un élément donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence RECUPERER_PARENT IdElement IdElementResultat CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
NUM_BIN_4 IdElementResultat |
Identifiant de l'élément père résultat (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour
|
|
-2 |
Erreur lors de la récupération de l'élément père, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
RECUPERER_POSITION_CURSEUR
Localise le premier et le dernier caractère sélectionnés dans le champ de saisie de l'élément.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence RECUPERER_POSITION_CURSEUR IdElement PositionDebut PositionFin CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
NUM_BIN_4 PositionDebut |
Position du premier caractère sélectionné (paramètre en sortie), |
NUM_BIN_4 PositionFin |
Position du premier caractère après le dernier caractère sélectionné (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-2 |
L'élément n'est pas en mode édition, |
-1 |
L'identifiant de l'élément passé en paramètre est invalide, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
Remarque : cette méthode n'est pas mise en oeuvre par le générateur Java.
RECUPERER_PRECEDENT
Retourne l'élément frère précédant un élément donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence RECUPERER_PRECEDENT IdElement IdElementResultat CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
NUM_BIN_4 IdElementResultat |
Identifiant de l'élément frère résultat (peut avoir la valeur _ARB_AUCUN si l'élément n'a pas de précédent) (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
RECUPERER_PROFONDEUR
Retourne la profondeur d'un élément nSud donné. La profondeur d'un arbre ayant comme racine l'élément e1 est la longueur du plus grand chemin (en terme d'éléments) partant de e1.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence RECUPERER_PROFONDEUR IdElement Profondeur CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
NUM_BIN_2 Profondeur |
Profondeur de l'arbre de racine IdElement (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-2 |
Erreur lors du calcul de la profondeur, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
RECUPERER_SUIVANT
Retourne l'élément frère suivant un élément donné.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence RECUPERER_SUIVANT IdElement IdElementResultat CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
NUM_BIN_4 IdElementResultat |
Identifiant de l'élément frère résultat (peut avoir la valeur _ARB_AUCUN si l'élément n'a pas de suivant) (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
RECUPERER_TEXTE
Retourne le texte associé à un élément.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence RECUPERER_TEXTE IdElement Texte CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
ALPHA(250) Texte |
Texte de l'élément (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-2 |
Erreur lors de la récupération du texte de l'élément, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
RECUPERER_VARIABLE_ASSOCIEE
Retourne la variable associée à un élément.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence RECUPERER_VARIABLE_ASSOCIEE IdElement VariableAssociee CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément (paramètre en entrée), |
Nom de VariableAssociee |
Variable devant contenir la valeur de la variable associée (paramètre en sortie), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour
|
|
-3 |
Il n'y a pas de variable associée à l'élément IdElement , |
-2 |
Erreur lors de la récupération de la variable associée de l'élément, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
| Conditions d'utilisation | |
Pour utiliser correctement cette méthode, il faut :
|
|
SUPPRIMER
Supprime un élément.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence SUPPRIMER IdElement CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément à supprimer (paramètre en entrée), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
Valeurs possibles du code retour |
|
-2 |
Erreur lors de la suppression de l'élément, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Conditions d'utilisation |
Aucune. |
TRIER
Trie les éléments de l'arbre dont la racine est un élément donné. Le tri s'effectue sur les textes des éléments.
Syntaxe |
|
APPELER_METHODE NomObjetArborescence TRIER IdElement Asc Profondeur CodeRetour |
|
Paramètres |
|
NUM_BIN_4 IdElement |
Identifiant de l'élément racine de l'arbre à trier (paramètre en entrée), |
BOOL Asc |
Ordre du tri (*VRAI pour ascendant, *FAUX pour descendant) (paramètre en entrée) , |
BOOL Profondeur |
*VRAI pour appliquer le tri à tous les éléments de l'arbre, *FAUX pour appliquer le tri sur les seuls fils de l'élément racine de l'arbre (paramètre en entrée), |
NUM_BIN_2 CodeRetour |
Code retour de l'opération (paramètre en sortie). |
| Valeurs possibles du code retour | |
-2 |
Erreur lors du tri de l'arbre, |
-1 |
La valeur du paramètre IdElement est incorrecte, |
0 |
Erreur interne, |
1 |
Opération correctement effectuée. |
Voir aussi...
APPELER_METHODE NomObjetArborescence FIXER_EDITION IdElement Edition CodeRetour