FWlum

Plus vite, plus loin !

Documentation de FWlum

Voir aussi : Documentation de FWlum UI

Les méthodes utilisées ont été testées sur Firefox 3.5, IE8, Opera 10 et Webkit.

Insertions

after(newel)
Insère l'élément newel après this.
append(newel, nobr)
  1. Si newel est une chaîne de caractères ou un nombre, insère le texte newel à la fin de l'élément this.
  2. Sinon, insère l'élément newel à la fin de l'élément this.
appendCode(code)
Transforme code en xHTML puis l'insère à la fin de l'élément this (déconseillée).
appendFct(newel, callback)
Insère l'élément newel à la fin de l'élément this et effectue la fonction callback. Dans cette fonction, this est l'élément newel.
appendText(text, nobr)
Insère le texte text à la fin de l'élément this. Par défaut, les sauts de lignes de text sont transformés pour apparaitre dans le rendu. Si nobr à la valeur true, les sauts de lignes ne seront pas transformés.
appendTo(oldel)
Insère l'élément this à la fin de l'élément oldel.
before(newel)
Insère l'élément newel avant this.
prepend(newel)
Insère l'élément newel au début de l'élément this.
prependTo(oldel)
Insère l'élément this au début de l'élément oldel.

Class

addClass(name)
Ajoute la class name à l'élément this.
getClass(name)
  1. Si name n'est pas définie, renvoie la valeur de l'attribut class de l'élément this.
  2. Si name est définie, renvoie la liste des éléments portant la class name dans l'élément this.
hasClass(name)
Renvoie true si name est une des class définie de l'élément this.
removeClass(name)
  1. Si name est définie, supprime la class name de l'élément this.
  2. Sinon, supprime l'attribut class de l'élément this
toggleClass(name)
Si hasClass(name) renvoie true, effectue removeClass(name) sinon, addClass(name).

Evenements

active(onev, callback)
  1. A l'évènement mousedown (début du click) sur this, execute onev.
  2. A l'évènement mouseup (fin du click) sur this, execute callback.
click(callback)
Execute callback au click sur this.
event(event, callback)
Execute callback à l'évenement event sur this.
focus(onev, callback)
  1. A l'évènement focus sur this, execute onev.
  2. A l'évènement blur (fin du focus) sur this, execute callback.
hover(onev, callback)
  1. A l'évènement mouseover (passage du curseur) sur this, execute onev.
  2. A l'évènement mouseout (sortie du curseur) sur this, execute callback.
$.load(callback)
Execute callback lorsque la page est chargée.

Suppression

remove()
Supprime this et le renvoie.
removeAll()
Supprime le contenu de this.

Selecteurs

getClass(name)
  1. Si name n'est pas définie, renvoie la valeur de l'attribut class de l'élément this.
  2. Si name est définie, renvoie la liste des éléments portant la class name dans l'élément this.
id(name)
  1. Si name n'est pas définie, renvoie la valeur de l'attribut id de l'élément this.
  2. Si name est définie, renvoie l'élément désigné par l'ID name dans this. Renvoie false si l'élément n'existe pas.
tag(name)
  1. Si name n'est pas définie, renvoie le nom de la balise this.
  2. Si name est définie, renvoie le premier élément étant une balise nommée name dans this. Renvoie false si l'élément n'existe pas.
tags(name)
Renvoie la liste des éléments étant une balise nommée name dans this.

Obtention et modification d'information

attr(attr, val)
  1. Si attr n'est pas définie, renvoie l'objet attributes de l'élément this.
  2. Si val est définie, la méthode modifie alors l'attribut attr en lui donnant la valeur val. Si val est null, l'attribut est supprimé.
  3. Si attr est une chaine de caractères, renvoie l'attribut attr de l'élément this.
  4. Sinon attr doit être un tableau associatif, la méthode modifie alors tous les attributs de this correspondant aux clefs du tableau en leur assignant les valeurs associées.
css(attr, val)
  1. Si attr n'est pas définie, renvoie l'objet style de l'élément this.
  2. Si val est définie, la méthode modifie alors le style de this en assossiant l'attribut CSS val à attr.
  3. Si attr est une chaine de caractères, renvoie l'attribut style attr de l'élément this.
  4. Sinon attr doit être un tableau associatif, la méthode modifie alors tous les attributs style de this correspondant aux clefs du tableau en leur assignant les valeurs associées.
NB: le style opacity est géré par le script pour IE.
data(attr, val)
L'objet data est un élément du cache.
  1. Si attr n'est pas définie, renvoie l'objet data associé à l'élément this.
  2. Si val est définie, la méthode modifie alors l'attribut data de this en assossiant val à attr.
  3. Si attr est une chaine de caractères, renvoie l'attribut data attr de l'élément this.
  4. Sinon attr doit être un tableau associatif, la méthode modifie alors tous les attributs data de this correspondant aux clefs du tableau en leur assignant les valeurs associées.
getCode()
Renvoie le code du contenu de this.
text()
Renvoie le texte (sans les balises) du contenu de this.

Effets spéciaux

L'argument time dans les éléments suivants :
L'effet dure time ms (millisecondes). Utilisez "fast" pour rapide et "slow" pour lent. Valeur par défaut : 800. L'argument callback est falcultatif.
show(callback)
Affiche l'élément this et lance la fonction callback à la fin de l'effet.
show(time, callback)
Affiche l'élément this et lance la fonction callback à la fin de l'effet.
hide(callback)
Cache l'élément this et lance la fonction callback à la fin de l'effet.
hide(time, callback)
Cache l'élément this et lance la fonction callback à la fin de l'effet.
fadeOut(callback, opacity)
Affiche l'élément this avec un effet de fondu et lance la fonction callback à la fin de l'effet. L'effet s'arrête lorsque l'opacité opacity est atteinte.
fadeOut(time, callback, opacity)
Affiche l'élément this avec un effet de fondu et lance la fonction callback à la fin de l'effet. L'effet s'arrête lorsque l'opacité opacity est atteinte. opacity est une valeur comprise entre 0 et 1.
fadeIn(callback)
Cache l'élément this avec un effet de fondu et lance la fonction callback à la fin de l'effet.
fadeIn(time, callback)
Cache l'élément this avec un effet de fondu et lance la fonction callback à la fin de l'effet.
scrollTo(to, callback)
Si possible, effectue un scroll (vertical uniquement) dans l'élément this jusqu'au point to avec un effet de déplacement. to peut avoir comme valeur :
  1. Un nombre qui correspond au nombre de pixel par rapport au haut de l'élément.
  2. Une chaîne de caractère commençant par # correspondant à une ancre, c'est-à-dire, l'id d'un élément.
  3. La valeur "bottom", envoyant directement au bas de la page.
Appelle callback une fois cet effet terminé.
scrollTo(to, speed, callback)
Si possible, effectue un scroll (vertical uniquement) dans l'élément this jusqu'au point to avec un effet de déplacement. to peut avoir comme valeur :
  1. Un nombre qui correspond au nombre de pixel par rapport au haut de l'élément.
  2. Une chaîne de caractère commençant par # correspondant à une ancre, c'est-à-dire, l'id d'un élément.
  3. La valeur "bottom", envoyant directement au bas de la page.
Appelle callback une fois cet effet terminé.

Actions supplémentaires

clone()
Copie this et renvoie sa copie.
el(DOMel)
  1. Si DOMel n'est pas définie, renvoie l'élément DOM this.
  2. Si DOMel est une chaîne de caratères, crée un nouvel élément DOMel et le renvoie.
  3. Si DOMel est définie, renvoie l'objet $DOM(DOMel).

Liste d'éléments

each(fonction)
Execute fonction pour chaque élement de la liste.
index(n)
Renvoie l'élément this[n].
length
Renvoie le nombre d'éléments contenus par la liste.

Autres

$
Renvoie l'objet $DOM(document). Il s'agit de l'élément de base !
$.body
Renvoie l'objet $DOM(document.body) (après l'évènement load).
$.ajax(method, action, data, callback)
Utilise XMLHttpRequest sur le fichier action avec la méthode method (POST ou GET) et envoie les informations contenues dans l'objet data. La fonction callback est optionnelle. Le premier attribut envoyé à cette fonction correspond au document reçu.
$.attrlink(obj)
Convertit l'objet obj en URI.
$.agent.DOM
Renvoie true si le navigateur supporte le DOM (Necessaire pour le script).
$.agent.IE4 & $.agent.NS4
Renvoie true si le navigateur est Internet Explorer 4 ou Netscape 4 (Ceci est quasiment impossible et il sert simplement à stopper le script).
Il est préférable de n'utiliser ces propriétés que si aucun test de capacité autres que ceux utilisés ci-après ne peuvent différencier le comportement des navigateurs par rapport à l'action voulue.
Ex: pour AJAX, il est préférable d'utiliser if(window.ActiveXObject) plutôt que if($.agent.IE)
$.agent.IE
Renvoie true si le navigateur utilisé est Internet Explorer.
$.agent.FX
Renvoie true si le navigateur utilisé utilise Gecko.
$.agent.OP
Renvoie true si le navigateur utilisé utilise le moteur d'Opera.
$.agent.UNK
Renvoie true si le navigateur ne correspond à aucun des navigateurs précédents.
$.inArray(array, variable)
Renvoie true si la valeur variable est présente dans le tableau array.
Object.each(fonction)
Applique la fonction fonction à chaque attribut de l'objet Object. fonction a un argument qui est la clef de chaque attribut. L'objet est contenu dans this.
Array.each(fonction)
Applique la fonction fonction à chaque case du tableau Array. fonction a un argument qui est la clef de chaque case du tableau contenu dans this.
Object.key(value)
Renvoie l'attribut de la première clef ayant value pour valeur. Renvoie null si aucune clef n'a la valeur value.
Array.key(value)
Renvoie la première clef ayant value pour valeur. Renvoie -1 si aucune clef n'a la valeur value.

Top