Les méthodes de l'objet COLONNE

DECLENCHER_ACTION_FILTRE

Déclenche l'événement ActionFiltre.

Syntaxe

APPELER_METHODE NomObjetColonne DECLENCHER_ACTION_FILTRE ValeurInterneFiltre ValeurExterneFiltre CodeRetour

Paramètres

Alpha(250) ValeurInterneFiltre (E)

Valeur qui sera affectée à la propriété VALEUR_INTERNE_FILTRE.

Alpha(250) ValeurExterneFiltre (E)

Valeur qui sera affichée dans le menu contextuel des filtres utilisés.

NUM_BIN_4 CodeRetour (S)

Code de retour de l'opération.

Valeurs possibles :

_ERR_OK	L'exécution de la méthode s'est déroulée correctement.
_ERR_ANOMALIE_EXEC	Une erreur inattendue s'est produite.

Conditions d'utilisation

La propriété FILTRE doit valoir _COL_FILTRE_MANUEL.

FIXER_NUMERO_ORDRE

Cette méthode permet de fixer le numéro d'ordre d'une colonne. Elle est utile pour redonner à l'utilisateur l'ordre qu'il avait choisi lors d'une exécution précédente.

Les colonnes sont numérotées à partir de 1 quelle que soit leur visibilité.

Syntaxe

APPELER_METHODE NomColonne FIXER_NUMERO_ORDRE NumeroOrdre CodeRetour

Paramètres :

NUM_BIN_4 NumeroOrdre (E)

Numéro d'ordre de la colonne.

NUM_BIN_4 CodeRetour (S)

Code de retour de l'opération.

Valeurs possibles :

_ERR_OK	L'exécution de la méthode s'est déroulée correctement.
_ERR_PARAM_INVALIDE	Le numéro d'ordre n'est pas compris entre 1 et le nombre de colonnes de la liste.
_ERR_ANOMALIE_EXEC	Une erreur inattendue s'est produite.

Conditions d'utilisation

Aucune

Remarques :

Il faut utiliser cette méthode en partant de 1 (ou du nombre de colonnes) pour obtenir l'ordre global voulu.

Cette méthode n'est pas mise en oeuvre par le générateur Java.

FIXER_POSITION_CURSEUR

Sélectionne un bloc de caractères dans le champ de saisie de la cellule.

Syntaxe

APPELER_METHODE NomObjetColonne FIXER_POSITION_CURSEUR NumLigne PositionDebut PositionFin CodeRetour

Paramètres :

NUM_BIN_4 NumLigne

Numéro de la ligne (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 :

-2	Impossible de rentrer en mode saisie sur l'élément (colonne en lecture seule ou ayant une représentation image ou case à cocher),
-1	Le numéro de ligne 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_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 des événements souris de l'objet Colonne.

Syntaxe

APPELER_METHODE NomObjetColonne 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 des éléments du tableau TabAutresTouches :

_COL_TOUCHE_CLAVIER_NUM0	Touche 0 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM1	Touche 1 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM2	Touche 2 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM3	Touche 3 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM4	Touche 4 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM5	Touche 5 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM6	Touche 6 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM7	Touche 7 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM8	Touche 8 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM9	Touche 9 du clavier numérique.
_COL_TOUCHE_CLAVIER_DECIMAL	Touche du séparateur décimal du clavier numérique.
_COL_TOUCHE_CLAVIER_SOUSTRAIRE	Touche de la soustraction du clavier numérique.
_COL_TOUCHE_CLAVIER_MULTIPLIER	Touche de la multiplication du clavier numérique.
_COL_TOUCHE_CLAVIER_ADDITIONNER	Touche de l'addition du clavier numérique.
_COL_TOUCHE_CLAVIER_DIVISION	Touche de la division du clavier numérique.
_COL_TOUCHE_CLAVIER_VERR_NUM	Touche du verrouillage du clavier numérique.
_COL_TOUCHE_CLAVIER_ENTREE	Touche Entrée.
_COL_TOUCHE_CLAVIER_ARRET_DEFIL	Touche Arrêt défilement.
_COL_TOUCHE_CLAVIER_FLECHE_GAUCHE	Touche flèche gauche.
_COL_TOUCHE_CLAVIER_FLECHE_DROITE	Touche flèche droite.
_COL_TOUCHE_CLAVIER_FLECHE_BAS	Touche flèche bas.
_COL_TOUCHE_CLAVIER_FLECHE_HAUT	Touche flèche haut.
_COL_TOUCHE_CLAVIER_PAGE_HAUT	Touche page haut.
_COL_TOUCHE_CLAVIER_PAGE_BAS	Touche page bas.
_COL_TOUCHE_CLAVIER_RETOUR_ARRIERE	Touche retour arrière.
_COL_TOUCHE_CLAVIER_ESPACE	Touche espace.
_COL_TOUCHE_CLAVIER_ECHAP	Touche Echap.
_COL_TOUCHE_CLAVIER_DEBUT	Touche Début.
_COL_TOUCHE_CLAVIER_FIN	Touche Fin.
_COL_TOUCHE_CLAVIER_INSER	Touche Inser.
_COL_TOUCHE_CLAVIER_SUPPR	Touche Suppr.
_COL_TOUCHE_CLAVIER_VERR_MAJ	Touche du verrouillage des majuscules.
_COL_TOUCHE_CLAVIER_TAB	Touche de tabulation.
_COL_TOUCHE_CLAVIER_MAJ_G	Touche Maj placée à gauche sur le clavier.
_COL_TOUCHE_CLAVIER_MAJ_D	Touche Maj placée à droite sur le clavier.
_COL_TOUCHE_CLAVIER_CTRL_G	Touche Ctrl placée à gauche sur le clavier.
_COL_TOUCHE_CLAVIER_CTRL_D	Touche Ctrl placée à droite sur le clavier.

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 :

_ERR_OK

L'exécution de la méthode s'est déroulée correctement.

Le paramètre TailleTabAutresTouches est inférieur à 0.

_ERR_PARAM_INVALIDE

Le paramètre TailleTabAutresTouches est supérieur à la longueur du tableau TabAutresTouches (uniquement en génération Cloud).

_ERR_FORMAT_INVALIDE

La variable AlphaNum contient des caractères invalides.

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.

INITIALISER_CHAMP_FILTRE

Positionne le champ filtre de la colonne à "*" et remet à blanc la propriété VALEUR_INTERNE_FILTRE.

Syntaxe

APPELER_METHODE NomObjetColonne INITIALISER_CHAMP_FILTRE CodeRetour

Paramètres :

NUM_BIN_4 CodeRetour (S)

Code de retour de l'opération.

Valeurs possibles :

_ERR_OK	L'exécution de la méthode s'est déroulée correctement.
_ERR_ANOMALIE_EXEC	Une erreur inattendue s'est produite.

Conditions d'utilisation

Aucune.

METTRE_FOCUS

Met le focus sur l'objet.

Syntaxe
APPELER_METHODE NomObjetColonne METTRE_FOCUS NumLigne
Paramètres
NUM_BIN_4 NumLigne	Numéro de la ligne (paramètre en entrée).
Conditions d'utilisation	Aucune

Remarque : cette méthode n'a d'effet que pour les colonnes qui ne sont pas en lecture seule.

RECUPERER_NUMERO_ORDRE

Cette méthode permet de récupérer le numéro d'ordre d'une colonne. Elle est utile pour stocker l'ordre choisi par l'utilisateur, afin de le reproduire lors de l'exécution suivante.

Les colonnes sont numérotées à partir de 1 quelle que soit leur visibilité.

Syntaxe

APPELER_METHODE NomColonne RECUPERER_NUMERO_ORDRE NumeroOrdre CodeRetour

Paramètre

NUM_BIN_4 NumeroOrdre (S)

Numéro d'ordre de la colonne.

NUM_BIN_4 CodeRetour (S)

Code retour de l'opération.

Valeurs possibles :

_ERR_OK	L'exécution de la méthode s'est déroulée correctement.
_ERR_ANOMALIE_EXEC	Une erreur inattendue s'est produite.

Conditions d'utilisation

Aucune

Remarque : cette méthode n'est pas mise en oeuvre par le générateur Java.

RECUPERER_POSITION_CURSEUR

Localise le premier et le dernier caractère sélectionnés dans le champ de saisie de la cellule.

Syntaxe

APPELER_METHODE NomObjetColonne RECUPERER_POSITION_CURSEUR NumLigne PositionDebut PositionFin CodeRetour

Paramètres :

NUM_BIN_4 NumLigne

Numéro de la ligne (paramètre en sortie).

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 :

-1	Aucune cellule de la colonne n'est en mode saisie,
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 et le générateur Cloud.

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 souris sur l'objet Colonne.

Syntaxe

APPELER_METHODE NomObjetColonne 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 Colonne.

BOOL EtatToucheCtrl (S)

Rend *Vrai si la touche clavier Ctrl était dans l'état "enfoncé" lors du dernier événement souris sur l'objet Colonne.

BOOL EtatToucheAlt (S)

Rend *Vrai si la touche clavier Alt était dans l'état "enfoncé" lors du dernier événement souris sur l'objet Colonne.

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

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

Valeurs possibles des éléments du tableau TabAutresTouches :

_COL_TOUCHE_CLAVIER_NUM0	Touche 0 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM1	Touche 1 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM2	Touche 2 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM3	Touche 3 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM4	Touche 4 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM5	Touche 5 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM6	Touche 6 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM7	Touche 7 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM8	Touche 8 du clavier numérique.
_COL_TOUCHE_CLAVIER_NUM9	Touche 9 du clavier numérique.
_COL_TOUCHE_CLAVIER_DECIMAL	Touche du séparateur décimal du clavier numérique.
_COL_TOUCHE_CLAVIER_SOUSTRAIRE	Touche de la soustraction du clavier numérique.
_COL_TOUCHE_CLAVIER_MULTIPLIER	Touche de la multiplication du clavier numérique.
_COL_TOUCHE_CLAVIER_ADDITIONNER	Touche de l'addition du clavier numérique.
_COL_TOUCHE_CLAVIER_DIVISION	Touche de la division du clavier numérique.
_COL_TOUCHE_CLAVIER_VERR_NUM	Touche du verrouillage du clavier numérique.
_COL_TOUCHE_CLAVIER_ENTREE	Touche Entrée.
_COL_TOUCHE_CLAVIER_ARRET_DEFIL	Touche Arrêt défilement.
_COL_TOUCHE_CLAVIER_FLECHE_GAUCHE	Touche flèche gauche.
_COL_TOUCHE_CLAVIER_FLECHE_DROITE	Touche flèche droite.
_COL_TOUCHE_CLAVIER_FLECHE_BAS	Touche flèche bas.
_COL_TOUCHE_CLAVIER_FLECHE_HAUT	Touche flèche haut.
_COL_TOUCHE_CLAVIER_PAGE_HAUT	Touche page haut.
_COL_TOUCHE_CLAVIER_PAGE_BAS	Touche page bas.
_COL_TOUCHE_CLAVIER_RETOUR_ARRIERE	Touche retour arrière.
_COL_TOUCHE_CLAVIER_ESPACE	Touche espace.
_COL_TOUCHE_CLAVIER_ECHAP	Touche Echap.
_COL_TOUCHE_CLAVIER_DEBUT	Touche Début.
_COL_TOUCHE_CLAVIER_FIN	Touche Fin.
_COL_TOUCHE_CLAVIER_INSER	Touche Inser.
_COL_TOUCHE_CLAVIER_SUPPR	Touche Suppr.
_COL_TOUCHE_CLAVIER_VERR_MAJ	Touche du verrouillage des majuscules.
_COL_TOUCHE_CLAVIER_TAB	Touche de tabulation.
_COL_TOUCHE_CLAVIER_MAJ_G	Touche Maj placée à gauche sur le clavier.
_COL_TOUCHE_CLAVIER_MAJ_D	Touche Maj placée à droite sur le clavier.
_COL_TOUCHE_CLAVIER_CTRL_G	Touche Ctrl placée à gauche sur le clavier.
_COL_TOUCHE_CLAVIER_CTRL_D	Touche Ctrl placée à droite sur le clavier.

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 :

_ERR_OK

L'exécution de la méthode s'est déroulée correctement.

Le paramètre TailleTabAutresTouches est inférieur à 0.

_ERR_PARAM_INVALIDE

Le paramètre TailleTabAutresTouches est supérieur à la longueur du tableau TabAutresTouches (uniquement en génération Cloud).

_ERR_CTX_UTILISATION

La méthode FIXER_TOUCHES_EVT_SOURIS n'a pas été appelée précédemment ou a été appelée avec les paramètres booléens à *Faux, la variable AlphaNum vide et le paramètre TailleTabAutresTouches à 0.

Conditions d'utilisation

La méthode FIXER_TOUCHES_EVT_SOURIS doit être précédemment appelée.

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 _COL_TOUCHE_CLAVIER_MAJ_G et _COLTOUCHE_CLAVIER_MAJ_D pour la touche Maj et _COL_TOUCHE_CLAVIER_CTRL_G et _COL_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.

Voir aussi...

Page:

COLONNE (Contexte Visual Adélia)
Page:

Les méthodes de l'objet COLONNE
Page:

Les propriétés de l'objet COLONNE
Page:

Les propriétés liées aux événements de l'objet COLONNE
Page:

Les événements de l'objet COLONNE

↑ Haut de page