$out.setStyle¶

Description¶

Définit le style à utiliser pour effectuer la transformation de l'arbre de sortie.

Syntaxe¶

$out.setStyle( style [ , options ] )

Paramètres¶

style string

Nom du style à utiliser. Doit référencer le nom d'une entrée styles/style du config

options map

Map d'options pour le changement de style. Les options reconnues sont:

asMainStyle boolean

Flag true/false indiquant si le style est à définir en tant que style principal (c'est-à-dire en tant que style appliqué pour la requête actuelle et pour les requêtes futures) ou en tant que style temporaire (uniquement pris en compte pour requête en cours).

La valeur par défaut est true.

priority number

Priorité de style.

La priorité de style sert à gérer les conflits où deux parties d'une application cherchent à redéfinir le style au niveau de la session. Par exemple, un script veut forcer la feuille de style de session pour une catégorie de sujet. En parallèle, un utilisateur force un appel à l'action setStyle. On a donc un conflit car le script veut imposer un style et l'action setStyle vient changer ce style. On utilise donc la notion de priorité pour permettre au script de s'imposer. Les styles définis par setStyle sont toujours effectués avec une priorité de 0. Le script peut donc forcer une priorité supérieure pour éviter que le style ne puisse être modifié ensuite.

Le niveau de priorité est réinitialisé à chaque nouvelle requête.

ignorePolicies boolean

Flag indiquant de ne pas tenir compte des policies lors du traitement.

Par défaut, les policies sont vérifiées si l'application gère des policies et si le thread courant est un thread "client", c'est-à-dire un thread initié par une requête du client. Si la méthode est invoquée par un script démarré par le scheduler, les policies ne seront pas vérifiées par défaut.

notify boolean

Flag true/false indiquant si le moteur doit déclencher la notification app-setstyle. Par défaut le flag est false.

Voir la description détaillée dans la documentation de la méthode $doc.create.

notificationParams map

Paramètres supplémentaires à passer lors de la notification app-setstyle.

Le paramètre attendu est un map de clés-valeurs. Le fait de spécifier des paramètres de notification active automatiquement l'option notify (pour autant qu'elle ne soit pas explicitement définie à false).

Retour¶

Retourne true si le style peut être défini (c.-à-d. qu'il est déclaré dans le fichier de config) et qu'il peut être appliqué, sinon false.

Exemple¶

Non disponible