Icônes

Modifier l’icône des composants en Javascript


Chaque catégorie de composant dispose de sa propre icône dans FlowerDocs GUI. Pour les tâches, l’icône peut être définie par classe pour disposer d’une icône différente en fonction de l’étape utilisateur.

Icon Resolver

Dans certaines situations, il peut être nécessaire de définir une icône en fonction des tags d’un composant. Pour cela, il est possible de définir un Icon Resolver permettant de définir l’icône à appliquer à un composant. Plusieurs Icon Resolver peuvent être définis, dans ce cas, le premier répondant avec une valeur sera pris en compte.

Les Icon Resolvers sont utilisés pour résoudre l’icône d’un composant lorsqu’il est affiché :

  • dans un formulaire d’indexation
  • dans un tableau de résultats de recherche

Enregistrement

Un Icon Resolver peut être enregistré à l’aide de la fonction registerComponentIconResolver(resolver) exposée par JSAPI.get().getHelperFactory(). Le paramètre resolver correspond à une fonction acceptant deux paramètres :

  • component : le composant dont l’icône doit être définie
  • callback : objet dont la fonction onSuccess() doit être appelée une fois le calcul de l’icône terminé (dans le cas où l’icône n’est pas défini par l’Icon Resolver, la fonction onSuccess() être appelée sans valeur)


Exemple : Pour définir une icône de type loupe à tous les composants de classe CourrierEntrant, il est possible d’enregister un Icon Resolver tel que :

JSAPI.get().getHelperFactory().registerComponentIconResolver(function(component, callback){
  if(component.getClassId() == 'CourrierEntrant'){
    callback.onSuccess('fa fa-search');
  }else{
    callback.onSuccess(null);
  }
});