Ged Toolbox : Guide du développeur

Structure

La toolbox est gérée comme un objet Javascript.

L'objet est appelé gedToolbox , et est l'unique instance de la classe GedToolbox. Cet objet est déclaré dans la fonction JQuery $(). Tous les appels à la toolbox se font donc en appelant gedToolbox.

gedToolbox.show(args)

Cette fonction permet de montrer la toolbox sur une archive donnée. La toolbox est chargée en ajax (appel à ajax_ged_toolbox.htm ) la première fois, et un second appel sur le même objet ré-affiche la toolbox déjà chargée.

args.archive : (string) I_Key de l'archive sur laquelle porte la toolbox, si l'on charge une archive

args.folderKey et args.folderCode: (string) Clé et code du dossier à charger, si l'on charge un dossier.

Un des deux groupes d'arguments ci-dessus doit forcément être indiqué pour un bon affichage.

args.target : (jQuery object) Objet sur lequel doit s'afficher la toolbox. Obligatoire pour un bon affichage.

args.shift : (int) Permet de décaler l'affichage de la toolbox horizontalement, par rapport à l'objet cible.

args.tab : (string) Nom de l'onglet à ouvrir avec la toolbox. voir showTab().

args.force : (bool) Vrai pour forcer le recalcul de la toolbox (en ajax).

args.hide : (bool) Permet de cacher la toolbox. Ignore les autres arguments. Peut être appelé plus simplement avec gedToolbox.show(false) .

args.context : (string) Permet de définir le contexte d'ouverture de la toolbox. La valeur envoyée est passée dans un attributs de l'URL envoyée en AJAX, et est également chargée dans la variable 4D TBonus .

Astuce : La toolbox est fermée automatiquement, quelle que soit sa position, sur un simple appel à gedToolbox.show(false)

 

gedToolbox.repositionToolbox(target)

Permet de repositionner la toolbox automatiquement sur un objet. target est l'objet sur lequel on veut positionner la toolbox.

Cette fonction est appelée plusieurs fois au moment du calcul du contenu :

- Lorsque l'on affiche le gif de chargement

- Lorsque l'Ajax se termine et que le contenu est affiché

- Lorsque l'image du bloc de gauche est chargée (cela peut en effet venir après que le contenu soit chargé)

Cette fonction se charge du positionnement dans la page : Elle affiche la toolbox à droite de target , en prenant en compte un éventuel args.shift qui aurait été défini lors du premier appel à gedToolbox.show() .

Elle modifie le placement vertical pour s'assurer que la toolbox ne dépasse pas en bas de l'écran, le cas échéant.

Elle prend enfin également en charge le calcul de la largeur de la toolbox, en l'ajustant automatiquement au contenu.

Lorsqu'elle est appelée sans argument, elle se refixe automatiquement sur le dernier objet sur lequel elle était affiché, et dans ce cas, sa taille ne peut qu'augmenter, pour ne pas perturber l'utilisateur. Cela permet au changement d'onglet de grandir la toolbox si besoin.

Note : Un appel à cette fonction ne recalcule pas le contenu de la toolbox. Il permet juste de recalculer sa position et sa taille.

gedToolbox.showTab(tab)

Permet de changer l'onglet ouvert dans la toolbox courante (ou la dernière affichée).

tab est une chaîne de caractère donnant la classe du bloc à ouvrir (Exemple : "tab-infos").

Si tab n'est pas envoyé, showTab ouvre le premier onglet.

Note sur le fonctionnement des onglets :

Au chargement de la toolbox, tout lien avec la classe "kent-ico" qui se trouve directement dans le noeud ".contents" de la toolbox est automatiquement déplacé dans la barre d'onglets.

Pour que le lien ouvre le bon contenant, il faut qu'il ait pour attribut href un dièse (#) suivi de la classe du bloc <div> à ouvrir au clic sur le lien.

Exemple : Voir la ressource "AWEB_ged_toolbox_infos"

Astuce : Par défaut, le bloc de gauche affichant l'image n'est pas dépendant de l'onglet ouvert. Pour que l'ouverture d'un onglet cache l'image, il faut ajouter l'attribut data-noimage="true" sur le bloc du contenu de l'onglet.

gedToolbox.getTarget(cont)

Permet de récupérer un objet jQuery, correspondant à l'objet sur lequel la toolbox a été ouverte. cont est un objet jQuery qui permet de définir un conteneur toolbox (.wrapper ) pour lequel récupérer la GED. Si cont n'est pas défini on renvoit l'objet ayant provoqué l'ouverture de la toolbox courante (ou de la dernière ouverte).

this.getLastCont() : renvoi le dernier contenu de la toolbox affiché

this.isOn(elt) : renvoi "true" si la toolBox est actuellement affichée sur elt

this.action(href,callback) : permet de définir des événements sur des clics (ajouté une seule fois)

href : attribut href du lien devant déclencher l'action (plusieurs possibles, séparés par des virgules), sans #

callback : fonction appelée au clic, Reçoit le paramètre event ayant déclenché le clic

this.actionOff(href) : permet de supprimer un action

Action non déclenchée si class=inactive sur le lien

this.reload() : recharge la toolBox sur l'archive courante

this.getParam(param) : renvoie le paramètre demandé, récupéré depuis les champs cachés, pour la toolbox active

this.reset(target) : Supprime contenu de Toolbox. Si target est un objet jQuery, seul le contenu dont target est la cible est supprimé. (Permet de forcer un reload si on demande à rouvir cette toolbox)

Class : toolboxOpener pour ouvrir la toolbox