Ce widget permet d’afficher un champ à choix multiple dont la liste des élements à sélectionner provient soit d’un dictionnaire, soit d’un référentiel.
Hérite de WidgetField.
Fonction
Rendu
Utilisation
Le widget permet d’afficher un champ de sélection avec plusieurs choix (checkboxes). Les options de ce champ sont dynamiquement peuplées à partir d’un dataset (ensemble de données) ou d’un dictionnaire. Les éléments sélectionnés peuvent être récupérés ou modifiés selon les besoins de l’application. Attributs du widget
Le widget possède plusieurs options configurables, dont :
-
sSearchDataset
: Identifiant du dataset contenant les valeurs à afficher. -
oSearchDataset
: Données du dataset correspondantes à sSearchDataset. -
sValueField
: Le champ du dataset qui contient la valeur à stocker. -
sDisplayField
: Le champ du dataset qui contient la valeur à afficher. -
sOptgroupField
: Un champ permettant de regrouper les options par sections. -
bDisabledOptOn et bHideOptOn
: Conditions dynamiques pour désactiver ou masquer certaines options. -
bShowSearch et bShowSelectAll
: Permettent d’afficher un champ de recherche et une option pour sélectionner toutes les options. -
iNbColumns
: Le nombre de colonnes dans lesquelles les options seront réparties. -
sPlaceholder
: Le texte à afficher dans le champ de recherche lorsqu’il est vide.
Fonctionnalités clés
Recherche et sélection
: Le widget permet d’ajouter un champ de recherche pour filtrer les options et une case à cocher pour sélectionner toutes les options visibles.
Affichage dynamique
: Les options peuvent être regroupées en sections et des conditions dynamiques peuvent être appliquées pour afficher ou masquer certaines options, ou les rendre désactivées.
Gestion des valeurs sélectionnées
: Lorsque l’utilisateur sélectionne ou désélectionne des options, les valeurs correspondantes sont enregistrées dans un dataset cible, permettant de gérer les relations entre les données.
Méthodes importantes
-
Render
: Affiche le widget dans l’élément spécifié par sParentId. -
LoadSelection
: Charge les valeurs initialement sélectionnées. -
_generateMultiselectHtml
: Génére le code HTML pour le champ de sélection multiple. -
BuildOptions
: Crée les options pour le champ de sélection, avec possibilité de désactiver certaines d’entre elles. -
_initializeMultiselect
: Initialisation de l’élément de sélection multiple avec des options spécifiques comme le nombre de colonnes et les comportements de recherche. -
_onOptionClickedEvent et _onSelectAllEvent
: Gèrent les événements de sélection d’options et de sélection de toutes les options.
Mise en place
Le composant est obligatoirement lié à un varset principal.
Exemple du varset :
Exemple d’utilisation du widgetselectadv :
Attributs
Les attributs nécessaires au bon fonctionnement du widget sont signalés par un astérisque.
Ce widget hérite de fonctionnalités issues d’un autre widget. Consultez la documentation dédiée au WidgetField pour vérifier si d’autres attributs sont disponibles.
Options
Les options nécessaires au bon fonctionnement du widget sont signalées par un astérisque.
Ce widget hérite de fonctionnalités issues d’un autre widget. Consultez la documentation dédiée au WidgetField pour vérifier si d’autres options sont disponibles.
search_dataset*
L’id du dataset qui contient les valeurs à sélectionner ou le nom du dictionnaire s’il s’agit d’un dictionnaire
-
Version : >=2.26
-
Valeurs possibles : string
disabled_opt_on
Une expression dynamique se résolvant en un booléen permettant de déterminer si un enregistrement du search_dataset ne doit pas être sélectionnable.
-
Version : >=2.26
-
Valeurs possibles : Boolean (true ou false)
display_field
Champ du search_dataset qui contient la valeur à afficher. La valeur par défaut est “label”. Le widget se mettra en erreur si la valeur passée à l’option n’est pas une string ou si le champ n’existe pas au sein du search_dataset.
-
Version : >=2.26
-
Valeurs possibles : String
-
Valeur par défaut : label
hide_opt_on
Une expression dynamique se résolvant en un booléen permettant de déterminer si un enregistrement du search_dataset ne doit pas être affichés.
-
Version : >=2.26
-
Valeurs possibles : Boolean (true ou false)
nb_columns
Permet de répartir la liste des choix disponibles sur un nombre de colonnes déterminé. Le widget se mettra en erreur si la valeur passée à l’option ne correspond pas à un nombre ou si ce nombre est inférieur ou égal à zéro.
-
Version : >=2.26
-
Valeurs possibles : integer
-
Valeur par défaut : 3
optgroup_field
Nom d’un champ du search_dataset contenant une valeur permettant de regrouper les choix disponibles par section. La valeur du champ sera aussi le nom de la section.
-
Version : >=2.26
-
Valeurs possibles : String
placeholder
Texte affiché dans le champ de recherche lorsqu’il est vide.
-
Version : >=2.26
-
Valeurs possibles : String
-
Valeur par défaut : Rechercher
show_search
Permet d’afficher un champ de recherche pour filtrer la liste de choix.
-
Version : >=2.26
-
Valeurs possibles : Boolean (true ou false)
show_select_all
Permet d’afficher une case pour sélectionner tous les choix affichés d’un coup.
-
Version : >=2.26
-
Valeurs possibles : Boolean (true ou false)
value_field
Champ du search_dataset contenant la valeur à stocker. Le widget se mettra en erreur si la valeur passée à l’option n’est pas une string ou si le champ n’existe pas au sein du search_dataset.
-
Version : >=2.26
-
Valeurs possibles : string
-
Valeur par défaut : id_data