9 Utiliser et écrire des scripts BeanShell

jPicEdt supporte maintenant le scriptage (autrement dit les "macros") au travers d’un interpréteur BeanShell incorporable. BeanShell est une extension de Java légère, extensible et incorporable, écrite par Pat Niemeyer (courriel). Elle suit la grammaire de Java (quoique avec une plus grande tolérance aux erreurs de syntaxe ; en particulier elle a la capacité d’un typage faible), ainsi, quiconque baragouine quelque peu en Java peut écrire des scripts BeanShell.

On peut trouver une documentation détaillé de BeanShell à : www.beanshell.org. Ceci dit, examiner les scripts fournis avec jPicEdt est un bon début. Vous aurez aussi besoin de la documentation de l’ API de jPicEdt (au cas où vous ne l’auriez pas encore installé, vous pouvez la re-installer depuis l’installeur jPicEdt), en particulier si vous avez besoin d’écrire des scripts impiquant des operations complexes. La class jpicedt.JPicEdt offre une grande variété de méthodes statiques (par ex. JPicEdt.newBoard() pour créer une nouvelle planche) qui peuvent remplir les besoins de base. Les autres classes importantes sont :

• jpicedt.ui.MDIManager pour la gestion des planches à dessin (créer une nouvelle planche, la déplacer, cascader les planches,…)
• jpicedt.ui.PEDrawingBoard et jpicedt.graphic.PECanvas (un objet de classe PEDrawingBoard comprend un objet de classe PECanvas et un objet de classe PEScrollPane) pour inter-agire avec les objets graphiques sélectionnés, zoomer, effectuer des opérations d’entrées/sorties, ou même tripatouiller avec le UndoManager :-), …
• jpicedt.graphic.model.Drawing pour ajouter des objets à une planche à dessin ;
• jpicedt.graphic.model.Element et ses implantations concrètes (ellipses, rectangles,…) pour affecter la forme et les attributs des objets graphiques ;
• jpicedt.graphic.view.View et ses implantations concrètes (ellipses, rectangles,…) pour affecter la façon dont les objets APPARAISSENT à l’écran (mais non celle dont ils sont formattés vers du code LaTeX);
• jpicedt.graphic.toolkit.EditorKit pour changer la façon dones les objets sont édités à la souris (c’est à dire, soit en affectant les comportements existants, soit en ajoutant de nouveaux).
• Les classes dans le paquetage jpicedt.format.*, pour interagir avec les types de contenu, c’est à dire changer la façon dont les objets sont formattés en LaTeX et/ou dont les fichiers TeX sont analysés syntaxiquement pour un format donné (LaTeX, eepic,…).

Toutes ces classes sont facilement extensibles, et peuvent aisément se ficher l’une dans l’autre (c’est le fameux schéma Contrôleur-Modèle-Vue …). En outre, les classes jpicedt.JPicEdt et jpicedt.graphic.toolkit.EditorKit contiennent une grande variété d’Actions (implantées comme autant de classes statiques) dont vous pouvez tirer des sous-classes et les ajouter à votre propre interface graphique. Référez-vous à la documentation de jpicedt.graphic.toolkit.PEAction pour savoir ce qu’est une Action et comment vous pouvez l’utiliser dans votre propre code.

Par commodité, quelques variables et methodes ont été prédéfinies, et sont disponibles dès le démarrage de la console BSH, et de celui des scripts exécutés à partir du menu "Scripts". Ce sont :

• board() : renvoie la planche à dessin PEDrawingBoard courante, ou null s’il n’y a aucune planche à dessin d’ouverte ;
• canvas() : renvoie une référence à la toile PECanvas active, c’est à dire celle tendue sur la planche à dessin PEDrawingBoard courante;
• drawing() : renvoie une référence sur le dessin Drawing (autrement dit le MODÈLE) attaché à la toile PECanvas ;
• editorkit() : renvoie une référence sur le EditorKit (autrement dit le CONTRÔLER) attaché à la toile PECanvas active ;
• mdimgr : variable prédéfinie référençant le MDIManager courant.
• clipboard : variable prédéfinie référençant le presse-papier locale partagé entre les planches à dessin (par opposition au presse-papier système, auquel vous pouvez accéder depuis jPicEdt en utilisant l’article de menu "Collage spécial", mais qui n’accepte rien d’autre que des données texte) ; nécessaire pour copier/coller des choses depuis/vers une toile PECanvas.
• preferences : variable prédéfinie référençant un objet de classe Properties retenant les préférences utilisateur.

9.1 OK, où dois-je mettre mes scripts ?

Les scripts de l’utilisateur (vos scripts) doivent être placés dans le sous-répertoire "macros" du répertoire utilisateur des données d’application de jPicEdt (par exemple, /home/user/.jpicedt/macros sous Unix, C:\Documents And Settings\votre_nom\.jpicedt\macros sous MSWindows). Les scripts doivent avoir l’extension .bsh. Les noms dans lesquels il y a des tirets bas (_) seront présentés avec des espaces à la place dans le menu Script (par exemple Multi_Copie.bsh apparaîtra comme "Multi Copie"). Vous pouvez appeler des scripts depuis d’autres script en utilisant la commande BSH source("chemin_de_l_autre_script");, et vous pouvez même ajouter vos propres classes Java en utilisant la commande addClassPath().

Utiliser la console BSH pour tester vos scripts, puis mettez les dans le répertoire indiqué ci-dessus, et ils apparaitront !