0

6 La navigation dans le manuel de Kentika est réservée aux utilisateurs identifiés



Librairie Javascript Kentika : tools.js

Librairie Javascript Kentika : tools.js

Listes des fonctions disponibles dans Kentika

Kentika Atomic s'appuie fortement sur le javascript pour son affichage. De nombreuses fonctions génériques existent donc. La plupart de ces fonctions sont intégrées dans la ressource File://kent-js/tools.js . Elles sont utilisables sur n'importe quelle page du portail Atomic.

Cette page a pour but de créer une documentation sur ces fonctions, sur laquelle les développeurs Kentika peuvent s'appuyer.

Liste des fonctions

clearIP() : supprime l'URL serveur d'une URL

newLine() : duplique une ligne de formulaire

$.iePlaceholder() : créé la fonction "placeholder" pour les anciennes version d'IE

array_find() : cherche dans un tableau

iframeResize() : redimensionne un iframe

$.kSerialize() : transforme un formulaire en chaine de caractère pour envoi en GET ou POST

$.kLoader() : Affiche le .gif de chargement de Kentika

$.scrollTo() : scroll un élément pour afficher un autre élément

$.getCellCoord() : renvoie les coordonnées d'une cellule d'un tableau

$.isOnScreen() : retourne vrai si $(this) est entièrement visible à l'écran

$.isUnder() : Détection de la position d'un élément

$.tableFilter() : transforme un input en champ de filtration d'un tableau

$.tableSort() : ajoute une option de tri sur les en-têtes de colonnes

kPushState()/kReplaceState()/kOnPopState : Applique les méthodes pushState/replaceState/onpopstate

kGetParam()/kSetParam() : Manipulation des paramètres de l'URL

kAjax() : Envoie de requête en AJAx avec gestion des erreurs

$.setBgAlpha() : Change la transparence de la couleur de fond d'un élément

triggerOnIdle() : Exécute une fonction lorsque le navigateur ne détecte pas d'activité (souris bougée, touche enfoncée) pendant un certain temps

getRN() : Renvoie le record num lié à un élément de la page en fonction de la page courante

$.fn.kToggleSelect() : Active ou désactive la possibilité de sélectionner des éléments de la page

$.fn.kEllipsis() : Permet de couper proprement du texte multiligne qui dépasse de son conteneur.

$.fn.makeFieldRequired() : Rend des champs saisissables obligatoires.

$.fn.hasEvent() : Vérifie si un élément à un événement attaché.

$.fn.setCarousel() : Anime un carrousel. Utilisé pour le carrousel par défaut et pour les KentApps.

$.fn.kAnimate() : Déclenche des animations CSS

$.fn.autocomplete() : En cours

kParseDate() : Parse une chaine de caractère de date en date javascript.

$.fn.makeMultivalue() : Rend une ligne de formulaire multivaluée.

setKBlur() : Fonction appelée dans plusieurs autres fonctions. Elle permet de gérer un événement "blur" au clic sur l'objet suivant, et pas seulement sur un blur navigateur. La fonction permet simplement de déclarer cet événement s'il n'est pas déclaré.

$.fn.modalShow() : Permet d'afficher un objet HTML qui sera ensuite caché sur un clic n'importe où sur la page, ailleurs que sur l'objet.

$.fn.makeField() : Transforme un conteneur HTML en un champ texte.

$.fn.makeCke() : Transforme un champ (de préférence textarea) en un champ CKE.

clearIP()

Syntaxe : clearIP(val)

Supprime la partie "host" d'une URl, si elle est présente. Fonction utilisée parce-qu'une ancienne version d'IE ajoute automatquement le host aux liens, même sur un lien du type . Utiliser $(this).attr('href') sur un tel lien renvoie "http://foo.bar/#Valeur ". Il vaut mieux donc utiliser clearIP($(this).attr('href') pour récupérer la valeur.

newLine()

Syntaxe : newLine(elt,nameRegex)

Duplique (clone profond, avec attributs et événements) une ligne de formulaire vide juste après l'objet jQuery elt . Tous les éléments du formulaire sont remis à zéro, et les id et name des éléments sont incrémentés de 1 par rapport au plus grand nombre du parent de elt .

nameRegex permet de définir le format des noms/identifiants pour savoir quel partie incrémenter. Par défaut, il a pour valeur /^(.+_)([0-9]+)$/ . Il faut impérativement que nameRegex renvoie en $1 la partie fixe des noms/identifiants, et en $2 la partie variable.

Cette fonction est utilisée entre autres dans les formulaires de saisie (valeur multivaluées) ou d'envoi de mails (destinataires).

$.fn.iePlaceholder()

Syntaxe : $(this).iePlaceholder()

Permet de simuler l'attribut placeholder sur des champs (input et textarea ) pour IE7 et IE8 : Fixe la valeur du champ à celui de l'attribut par défaut et sur perte de focus, et le remet à vide sur focus.

Fonction à appeler au chargement de la page sur les champs où l'appliquer.

array_find()

Syntaxe : array_find(array,obj,start,sfunc)

Fonction de recherche sur tableau, créée parce-que IE7-8 ne supportent pas array.indexOf().

array est le tableau où effectuer la recherche.

obj est l'objet à rechercher.

start est l'indice où commencer la recherche.

sfunc est une fonction permettant de définir l'algorithme de recherche, sous la forme : sfunc(a,s,r) a est l'élément courant du tableau, s est l'élément recherche, et r est un booléen indiquant si s est une expression régulière.

Par défaut, sfunc est la fonction suivante :

function (a,s,r)

{

return ((!r && a === s)||(r && s.test(a)))

}

iframeResize()

Syntaxe : iframeResize(iframe,maxH,maxW)

Permet de redimensionner une iframe après son chargement. La fonction doit être appelée sur chargement de l'iframe, et un objet jQuery référençant l'iframe doit être passé dans iframe .

maxH et maxW permettent de définir la hauteur et la hauteur maximum que peut prendre l'iframe. Ils peuvent prendre une taille en pixels, ou les chaîne de caractère 'none' (pas de changement de taille) ou 'contents' (taille du contenu). maxW peut également prendre la valeur 'box' qui permet de redimensionner le contenu de l'iframe en largeur pour s'adapter à la taille de l'iframe.

Par défaut, maxH a pour valeur 'contents' et maxW a pour valeur 'box' .

$.fn.kSerialize(not)

Syntaxe : $(this).kSerialize(not)

Sérialise (transforme en chaîne de caractères) le formulaire sur lequel est appliqué la fonction et renvoie le résultat encodé au format URL. Permet d'envoyer des formulaires en AJAX.

Le paramètre optionel not permet d'envoyer soit un objet jQuery, soit un sélecteur jQuery permettant d'identifier une liste de champs à ne pas inclure dans le résultat de la fonction.

$.fn.kLoader()

Syntaxe : $(this).kLoader(replace)

Permet d'afficher l'animation de chargement de Kentika dans un élément. Par défaut, sans attribut, ou si replace est true , le contenu de l'élément est remplacé. Si replace est false , l'animation est ajoutée à la fin de l'objet.

$.fn.scrollTo()

Syntaxe : $(this).scrollTo(elt)

Permet de faire défiler instantanément $(this) pour afficher elt (objet jQuery).

$.fn.getCellCoord()

Syntaxe : $(this).getCellCoord()

Renvoie un objet donnant les coordonnées d'une cellule d'un tableau par rapport au tableau. L'objet renvoyé a pour structure {top,left}.

$.fn.isOnScreen()

Syntaxe : $(this).isOnScreen()

Renvoie true si $(this) est appliqué cette fonction est entièrement visible à l'écran, c'est-à-dire si son bord supérieur et son bord inférieur sont tous deux sur l'écran. Peut retourner true pour un élément de hauteur zéro, mais pas pour un élément en display:none , par exemple.

$.fn.isUnder()

Syntaxe : $(this).isUnder(x,y)

Renvoie true si les coordonnées x et y se trouvent sur $(this). Utilisé la plupart du temps pour vérifier si la souris se trouve au-dessus d'un élément.

$.fn.tableFilter()

Syntaxe : $(this).tableFilter(mode,max)

Permet de transformer automatiquement un input text en filtre sur un tableau HTML. Le champ de recherche doit forcément être dans le tableau, et le filtre s'applique sur la colonne dans laquelle se trouve le champ (sauf la première ligne et/ou celle où se trouve le champ).

mode peut prendre la valeur 'text' (le filtre reste un champ texte), 'select' (le filtre est transformé en menu déroulant) ou 'auto' . Dans le dernier cas, le filtre devient un menu déroulant s'il y a moins de max valeurs distinctes (10 par défaut), et un champ text au-delà.

Note : Chaque valeur du tableau associée à un objet jQuery contenant la liste complète des lignes qui correspondent à chaque valeur est stockée en mémoire dans la javascript pour accélérer le filtre. Cela peut cependant être lourd pour la mémoire du navigateur sur des tableaux importants ou avec trop de valeurs distinctes.

$.fn.tableSort()

Syntaxe : $(this).tableSort(cols)

Permet d'ajouter automatiquement une fonction de tri sur des tableau HTML.

$(this) doit être un tableau, et cols un objet jQuery renvoyant les cellules où créer les boutons de tri (par défaut, chaque de la première ligne sont utilisées). Seules les lignes se trouvant après ces cellules seront triées.

Le script détecte automatiquement les colonnes qui ne contiennent que des chiffres ou, depuis le kit 3.0.2, que des dates, pour proposer un tri approprié au lieu d'un tri alphabétique.

Note : Chaque cellule du tableau est stockée en mémoire pour accélérer le tri. Cela peut cependant être lourd pour la mémoire du navigateur sur des tableaux importants. Ceci n'est plus vrai en kit 3.0.2 : tous les calculs sont fait au moment du clic sur le tri.

kPushState(), kReplaceState() et kOnPopState()

Syntaxe : kPushState(url, obj)

kReplaceState(url,obj)

kOnPopState(callback)

Ces trois fonctions permettent d'appeler les fonction de manipulation d'historique des navigateurs modernes sans créer d'erreurs sur les navigateurs plus anciens.

Les deux premières appellent respectivement window.history.pushState(obj,'',url) et window.history.replaceState(obj,'',url) .

La dernière appelle la fonction callback() sur window.onpopstate .

kGetparam() et kSetParam()

Fonctions de manipulation d'URLs via Javascript

Syntaxe : kGetParam(param, loc)

Renvoie la valeur du paramètre param dans l'URL définie par loc (ou dans l'URL courante si loc n'est pas défini). Si param n'existe pas, la fonction renvoie null . (Si param existe mais est vide, la fonction renverra une chaine vide.)

Syntaxe : kSetParam(params,loc)

Renvoie une chaîne de caractère contenant une URL dans laquelle les valeurs des paramètres définis dans params sont remplacés par les valeurs définies dans params. params est un objet dans lequel les attributs sont les noms des paramètres et les valeurs sont les valeurs que doivent prendre ces paramètres.

Si un paramètre a pour valeur une chaine vide ou null , il est supprimé de l'URl s'il existe.

L'URL de départ est définie par loc , ou par l'URL courante si loc n'est pas défini.

Attention : La fonction kSetParam ne modifie pas l'URL courante. Elle ne fait que renvoyer une chaîne de caractère contenant l'URL.

kAjax()

Syntaxe : kAjax(url,params,success,error)

Permet d'envoyer une requête AJAX en POST. url est l'URL de destination, params contient les différents paramètres à envoyer, soit sous forme d'objet soit sous forme d'une chaîne de caractères. En cas de succès, la fonction success est exécutée. En cas d'erreur, la fonction error est exécutée.

success comme error prennent chacune un seul argument, dans le premier cas le contenu renvoyé par l'AJAX, dans l'autre le code et le message d'erreur concaténés.

Attention : Afin de permettre de renvoyer des erreurs spécifique à Kentika, un erreur est renvoyée également si le contenu récupéré par l'ajax commence par le texte "error:", et ce qui suit ce texte est renvoyé à la fonction error .

$.fn.setBgAlpha()

Syntaxe : $(this).setBgAlpha(alpha,color)

Permet de modifier la transparence du fond de $(this). La transparence est fixée à alpha . Si color est défini, on fixe également la couleur à color . Sinon, on récupère la couleur de l'élément. Cette fonction ne marche que si color (ou le style background-color défini en CSS et renvoyé par jQuery.css()) est au format rgb() (ou rgba()).

triggerOnIdle()

Syntaxe : triggerOnIdle(callback,duration,onlyOnce)

Exécute la fonction callback si l'utilisateur est inactif pendant duration (durée en secondes). L'inactivité est définie comme une période pendant laquelle l'utilisateur n'effectue aucune des actions suivantes : clic souris, mouvement de la souris, frappe de clavier ou utilisation de la molette de la souris.

Si onlyOnce est vrai, callback ne s'exécute qu'une fois, et la fonction n'est plus prise en compte ensuite. Sinon, le décompte d'inactivité reprend après une nouvelle période d'inactivité.

getRN()

Syntaxe : $(this).getRN(elt)

Permet de renvoyer le record_num (identifiant unique des enregistrements dans Kentika) à partir d'une notice ou d'un élément d'une liste.

En notice, aucun argument n'est nécessaire. Le record_num est récupéré depuis l'élément .contents.record>.section>.header[id^="record"] .

En liste, elt est un objet jQuery pour lequel la fonction ira chercher le plus proche parent qui répond au sélecteur .article[id^="record"] .

Une fois l'élément correct sélectionné, la fonction extrait le record_num de l'identifiant correspondant.

Cette fonction est faite pour être utilisée sur les listes et notices par défaut de Kentika. Si elle doit être utilisée sur d'autres pages, il faut faire attention à la structure du HTML pour qu'elle fonctionne.

$.fn.kToggleSelect()

Syntaxe : $(this).kToggleSelect(on)

Permet d'activer (si on est vrai) ou de désactiver (si on est faux) la possibilité de sélectionner le texte de l'élément. Utilisé pour désactiver la sélection du texte lors du drag and drop.

$.fn.kEllipsis()

Syntaxe : $(this).kEllipsis(args)

Permet de couper le texte contenu dans $(this) pour qu'il ne dépasse pas. Lorsqu'elle est appelée, la fonction ajoute deux spans : <span class="kEllipsisVisible"> (qui contient le texte visible) et <span class="kEllipsisInvisible"> (qui contient le texte coupé). La fonction boucle depuis la fin du texte visible, et enlève les mots uns par uns (en utilisant tout espace blanc comme séparateur de mot), jusqu'à ce que le bloc de texte visible ne dépasse plus.

args.text permet de définir le texte d'ellipse ajouté après la coupure. Par défaut, il s'agit de [...] . Si args.clean est vrai, la fonction va également s'assurer qu'il n'y a pas de balises HTML ouvertes séparées de leurs balises fermées par la fonction. Si c'est le cas, la fonction ferme les balises non fermées, et les rouvre dans le texte caché.

La fonction kEllipsis() peut demander beaucoup de temps si le texte à couper est très long, ou s'il y a beaucoup d'éléments. Le temps est augmenté si args.clean est vrai. Il est donc préférable de n'utiliser cet argument que lorsque c'est nécessaire.

$.fn.makeFieldRequired()

Syntaxe : $(this).makeFieldRequired()

Utilisée sur des champs HTML (input, textarea, select), cette fonction permet de rendre le champ obligatoire.

La fonction a les effets suivants :

Elle ajoute la classe required sur le premier élément p ou li qui contient le champ sur laquelle la fonction est appelée, ainsi que sur le premier élément label contenu dans ce même parent. La classe required n'est ajoutée sur le label que si la valeur du champ est vide.

Elle attache ensuite un événement sur le formulaire parent du champ pour ajouter ou enlever la classe required du label en fonction de la valeur du champ. Elle active ou désactive également le bouton d'envoi du formulaire (à condition qu'il soit stylé avec $.fn.styleButton()) s'il reste des champs obligatoires non renseignés.

Note : l'événement est attaché au formulaire, pour optimiser le code. Il n'est attaché qu'une seule fois, même si la fonction makeFieldRequired est appelée plusieurs fois dans le même formulaire.

La gestion de l'apparence du label avec la classe required est gérée en CSS.

$.fn.hasEvent()

Syntaxe : $(this).hasEvent(name)

Cette fonction renvoie true si un événement jQuery name a été rattaché à l'élément sur lequel elle est appelée.

name peut également contenir un namespace jQuery, sous la forme event.namespace .

Dans les faits, la fonction boucle sur le tableau $(this).data('events') pour voir si l'évémement est présent.

$.fn.setCarrousel()

Syntaxe : $(this).setCarousel(args)

Appelée sur un objet javascript, cette fonction permet d'animer un carrousel. L'argument args qui peut contenir les attributs suivants :

wrapper : (Objet jQuery) Conteneur des éléments défilants. Par défaut, le premier ul de $(this).

items : (Objet jQuery) Objet contenant les éléments défilants. Par défaut, les enfants li de wrapper .

scrollers : (Objet jQuery) Objet contenant les éléments permettant de faire défiler manuellement le carrousel. Par défaut, tout élément contenu dans $(this) ayant pour classe next , prev ou index .

style : (string) Style du carrousel. Utilisé pour les styles du carrousel par défaut de Kentika. Peut prendre les valeurs noStyle , default , noText , Hover, Captions ou fullWidth . Par défaut, récupère la classe qui a une de ces valeurs dans $(this). Si aucune classe, la valeur noStyle est utilisée.

scale : (int array) Tableau de 3 valeurs qui sont utilisée comme multiplicateurs de taille. La troisième valeur est utilisée pour l'élément central, la seconde pour les éléments de chaque côté de l'élément central, et la première pour les autres. Cette fonctionnalité de tailles différentes n'est active que si args.scale est défini ou si args.style est noText . Dans ce dernier cas, scale vaut [0.6,0.8,1].

auto : (bool) Active le défilement automatique du carrousel. Vrai par défaut.

delay : (int) Temps, en millisecondes, entre deux défilements automatique. 2000 par défaut.

speed : (int) Temps, en millisecondes, de l'animation de défilement automatique. 1000 par défaut.

clickSpeed : (int) Temps, en millisecondes, de l'animation de défilement manuel. Par défaut, cette valeur est égale à la plus petite valeur entre 500 et args.speed .

margin : (int) Espacement entre les éléments défilant, en pixels. 5px par défaut.

maxWidth : (int) Largeur maximale des éléments défilants, en pixels. Utilisé lorsque style est différent de noStyle ou fullWidth . En style noStyle , chaque élément est mis à la largeur du plus large élément défilant. En mode fullWidth , chaque élément prend la largeur de args.wrapper . Par défaut dans les autres cas : 150px.

minWidth : (int) Largeur minimale des éléments défilants, en pixels. Calculée par défaut selon les éléments défilants. Si cette valeur est 0, prend 80px.

height : (int) Hauteur du carrousel, en pixels. Hauteur de args.wrapper si non défini. 100px si args.wrapper a une hauteur nulle.

reverse : (bool) Si vrai, fait défiler le carrousel (en mode automatique) en sens inverse de la normale (de droite à gauche au lieu de gauche à droite).

resizeToContent : (bool) Si vrai, recalcule la taille du carrousel par rapport à la taille du plus grand élément défilant.

indexFormat : (string ,function) Défini le format de l'index. (Voir plus bas). Par défaut : <span class="kent-ico font2">H</span>

cover : (bool) Permet de retailler les images dans les styles hover ou fullWidth pour qu'elles soient recadrées pour couvrir tout l'élément parent, au lieu d'être affichées en entier.

La fonction positionne automatiquement les éléments défilants dans leur conteneur, et assure le défilement automatique. Ce défilement automatique n'est pas activé s'il n'y a pas d'éléments à faire défiler (par exemple, s'il y a moins de 5 éléments dans un carrousel qui peut en afficher 5), ou s'il n'y a pas de manière de faire défiler manuellement le carrousel (pas d'élément args.scrollers ). Le défilement automatique se met en pause automatiquement lorsque la souris est sur le carrousel.

La fonction active automatiquement également le défilement manuel au clic sur les éléments définis dans args.scrollers . Ces éléments doivent avoir l'une des trois classes suivantes :

- next : Permet de faire défiler de la gauche vers la droite

- prev : Permet de faire défilter de la droite vers la gauche

- index : Cet élément doit être vide initialement. La fonction le rempli automatiquement avec un élément (défini par args.indexFormat ) par élément défilant. Par la suite, un clic sur l'un de ces éléments fait automatiquement défiler le carrousel jusqu'à l'élément défilant correspondant.

Si indexFormat est une fonction, elle est exécutée au moment de l'initialisation du carrousel une fois par élément défilant, avec pour argument cet élément.

À l'appel de la fonction, la taille optimale des éléments défilant est calculée automatiquement (sauf pour les styles noStyle et fullWidth ) en fonction des éléments présents dans le carrousel et de leur affichage tel qu'il est défini avec le CSS de la page. Tous les éléments sont ajustés à la même taille ainsi calculée.

Attention : Cette fonction seule ne suffit pas à mettre en place un carrousel : Il faut y ajouter des styles CSS.

Pour plus d'informations sur les carrousels par défaut de Kentika (en page d'accueil), voir ici.

Deux événements sont appelés lors du fonctionnement du carrousel :

kcarouselReady : Appelé lorsque l'initialisation du carrousel est terminée. L'événement reçoit pour argument la variable args , qui contient tous les paramètres mentionné ci-dessus.

kcarouselBeforeScroll : Appelé avant chaque défilement du carrousel. L'événement reçoit pour argument la variable args , et une variable mod définissant le sens du défilement : Cette variable est positive pour un défilement normal, et négative pour un défilement inverse. Elle a pour valeur le nombre d'éléments qui doivent défiler.

Exemple : si mod=-4, cela signifie que le carrousel va défiler de 4 éléments en sens inverse.

$.fn.kAnimate()

Syntaxe : $(this).kAnimate(animation,callback)

Ajoute une classe dont le nom est "kanim-" suivi de la valeur de animation , et enlève cette même classe après la durée de l'animation.

Cette fonction est à utiliser en conjonction avec des animations CSS. Par exemple, l'animation permettant de faire vibrer une icône sur notre portail commercial utilise le code ci-dessous :

CSS :

@keyframes knet-wiggle

{

0% {transform:rotateZ(20deg)}

33% {transform:rotateZ(-15deg)}

66% {transform:rotateZ(10deg)}

100% {transform:rotateZ(0deg)}

}

.kanim-knet-wiggle

{

animation-duration:.3s;

animation-name:knet-wiggle;

animation-timing-function:linear;

}

JAVASCRIPT :

$(this).kAnimate('knet-wiggle');

Si callback est une fonction, elle est appelée après l'animation. $(this) est envoyé en argument à la fonction.

$.fn.autocomplete()

Fonction en cours de développement...

kParseDate()

Syntaxe : kParseDate(val)

Retourne une date javascript d'après la chaine de caractère val , ou null si le format n'est pas reconnu.

L'analyse de la date reconnaît les formats DD/MM/YYYY, avec un ou deux chiffres pour le jour et le mois, deux ou quatres chiffres pour l'année. Des tirets peuvent être utilisés à la place des slashes. La date sera reconnue avec seulement le mois et l'année, ou seulement l'année (sur 4 chiffres).

Le format est le format français (DD/MM), sauf si le mois est supérieur à 12, auquel cas la fonction interprétera la date au format américain (MM/DD).

$.fn.makeMultivalue()

Syntaxe : $(this).makeMultivalue(nameRegex)

Cette fonction permet de rendre une ligne de formulaire (p ou ul) multivaluée. Cela signifie que, lorsque cette ligne contient un champ (input, textarea ou select) avec une valeur non vide, la ligne entière est dupliquée. Lorsqu'une ligne qui n'est pas la dernière du groupe est vidée, elle est supprimée.

Cette fonction prend en compte les champs obligatoires (avec $.fn.makeFieldRequired()).

La fonction ajoute deux classes sur la ligne : multivalue et multivalue-group-ID , où ID est le numéro de la ligne dans le formulaire. Ce numéro de ligne est également stocké dans le data mulvalue-group de la ligne.

setKBlur()

Syntaxe : setKBlur()

Cette fonction permet de définir un évenement kblur qui est appelé après le blur classique.

L'événement est appelé sur focus dans un autre champ que le champ courant, et sur click sur le document (ailleurs que dans l'autocomplétion).

Il est important d'appeler la fonction pour pouvoir utiliser l'événement kblur . Cet événement est par exemple utilisé sur pour l'autocomplétion, les champs multivalués et les champs obligatoires.

$.fn.modalShow()

Syntaxe : $(this).modalShow(args)

Permet de faire afficher un élément HTML, qui sera ensuite caché au clic n'importe où ailleurs sur la page.

Si args est false , l'élément est caché. Cela permet de "fermer" l'objet par programmation.

args.show : (fonction) Fonction appelée pour montrer l'objet. Par défaut, elle enlève la classe hide . this y est défini comme l'élément HTML sur lequel est appelé modalShow() .

args.hide : (fonction) Fonction appelée pour cacher l'objet. Par Défaut, elle ajoute la classe hide . this y est défini comme l'élément HTML sur lequel est appelé modalShow() . C'est également cette fonction qui est appelée lorsque args est false .

$.fn.makeField()

Syntaxe : $(this).makeField(args)

Cette fonction permet de transformer un élément HTML en champ texte (input type="text" ). Le contenu textuel de l'objet HTML est automatiquement inséré comme valeur par défaut du champ, et le champ remplace tout le contenu de l'objet HTML.

args.confirm : (fonction) Fonction appliquée lorsque le champ est validé (touche enter ). Elle reçoit en premier argument la valeur du champ.

args.cancel : (fonction) Fonction appliquée lorsque le champ est annulé (touche escape ). Elle reçoit en premier argument la valeur par défaut du champ (donc le contenu textuel de $(this) avant transformation).

args.exit : (fonction) Si cet argument existe, args.confirm et args.cancel ne sont pas pris en compte, et cette fonction s'applique sur confirmation ou annulation du champ. Elle reçoit, sur confirmation, la valeur du champ, sur annulation, la valeur par défaut.

Si args est false , cela simule par programmation une annulation. args.exit ou args.cancel est exécutée.

$.fn.makeCke()

Syntaxe : $(this).makeCke(args)

Permet de transformer un objet (typiquement un <textarea> ) en formulaire CK Editor. La fonction charge automatiquement les librairies nécessaires si elles ne sont pas présentes dans la page.

args.width : (string,integer) Permet de définir la largeur de la zone CK. Si "auto" (valeur par défaut), la largeur sera celle de $(this).

args.height : (string, integer) Permet de définir la hauteur de la zone CK. Si "auto" (valeur par défaut), la hauteur sera celle de $(this).

args.toolbar : (string array) Permet de définir la barre d'outil de CK. Voir la documentation CK pour le format (editor.config.toolbar ).