Présentation

Le script copix.js définit une classe contenant des méthodes utilitaires et des extensions de MooTools? spécifiques à Copix3.

Cette classe suit le patron de conception "singleton": une seule instance de la classe est créée et utilisée : Copix.

API

Copix.getActionURL(dest[, data])

Génère une URL pour une action Copix. Cette méthode fonctionne comme CopixURL::get() (ou _url()).

Paramètres

dest

Chaîne. Description de l'action, sous la forme classique "module|groupe|action".

data

Objet, optionnel. Paramètres à ajouter à la fin de l'URL.

Exemple

// Redirige sur l'action monModule|backoffice|refresh avec la chaîne de paramètre "id=5&value=truc+muche".
document.location.href = Copix.getActionURL('monModule|backoffice|refresh', {id:5,value:"truc muche"});

Copix.getResourceURL(path)

Génère l'URL d'une ressource. Cette méthode fonctionne comme CopixURL::getResource() (ou _resource()).

Paramètre

path

Chaîne. Chemin relatif de la ressource. Fonctionne également avec les ressources de module ("module|chemin/vers/fichier.ext").

Exemple

// Remplace le contenu d'un élément DOM par une image.
var imgURL = Copix.getResourceURL('img/monImage.png');
$('monTruc').setHTML('<img src="'+imgURL+'"/>');

Copix.queueEvent(element, event[, args])

Met en attente un événement. Il sera déclenché lorsque à la fin du bloc "domready" généré par CopixHTMLHeader::addJSDOMReadyCode().

Paramètres

element

Element. Elément DOM

event

Chaîne. Nom de l'événement à déclencher.

args

Tableau, optionnel. Arguments à passer avec l'événement.

Exemple

// Planifie un $('el').fireEvent('display', 5, 'truc')
Copix.queueEvent($('el'), 'display', [5, 'truc']);

Copix.addLink(options)

Ajoute un lien vers une ressource externe dans l'en-tête du document. Cela permet d'ajouter dynamiquement des scripts ou des feuilles de styles externes.

Paramètres

Les paramètres sont passés comme propriétés de l'objet options. Les différentes propriétés et leur signification sont :

id

Chaîne. Identifiant du lien. Sera ajouté comme attribut de la balise générée et sert à éviter d'ajouter plusieurs fois le même lien.

kind

Chaîne. Type de document, soit "javascript" soit "css".

url

Chaîne. URL du document externe.

Les autres propriétés seront ajoutées comme attributs de la balise générée (en plus des balises minimales).