Les templates complexes

Ce document vous explique comment créer vos propres templates.
Si vous désirez créer des templates plus simples lisez ceci (pages JSP, HTML, XML).

Attention : Même si les tags ressemblent à de l'XML, il n'en est rien (aujourd'hui). Ne prenez pas d'initiatives avec les tags.

Il y a plusieurs étapes à respecter :

Créer votre fichier template
- Particularité des fichiers templates
  - Dans tous les cas :
    - Déclaration d'un import :
      - Utilisez le tag : <aw:import>aValue</aw:import>
      - aValue représente la valeur de l'import
      - Attention : Un import et un seul par tag, pas de ;
      - Exemple :
        <aw:import>java.io.Serializable</aw:import>
    - Déclaration d'une interface implémentée par l'objet :
      - Utilisez le tag : <aw:interface>aName</aw:interface>
      - aValue représente le nom de l'interface
      - Attention : Une interface et une seule par tag, pas de implements ou ;. Utilisez les noms longs de préférence.
      - Exemple :
        <aw:interface>java.io.Serializable</aw:interface>
    - Déclaration de la super classe de l'objet :
      - commence par : <aw:parentClass> et se termine par </aw:parentClass>
      - Attention : Pas de extends ou ;. Utilisez les noms longs de préférence.
      - Exemple :
        <aw:parentClass>java.lang.Exception</aw:parentClass>
    - Tokens particuliers :
      - <aw:className/> : sera remplacé par le nom de la classe créée
      - <aw:packageName/> : sera remplacé par le nom du package spécifié
    - Déclaration d'un attribut :
      - commence par : <aw:field> et se termine par </aw:field>
      - Exemple :
        <aw:field> /** This is its int array. */ protected int[] anIntTab; </aw:field>
    - Déclaration d'un constructeur :
      - commence par : <aw:constructor name="aName"> et se termine par </aw:constructor>
      - aName représente le nom d'une clef, c'est à dire n'importe quoi d'unique
      - Attention : Si en utilisant le Wizard wous décochez la case "Create constructors", alors il n'y aura pas de constructeurs dans la classe générée.
      - Exemple :
        <aw:constructor name="C1"> /** * Constructor of the object. */ public <aw:className/>() { super(); } </aw:constructor>
    - Déclaration d'une méthode :
      - commence par : <aw:method name="aName"> et se termine par </aw:method>
      - aName représente le nom d'une clef, c'est à dire n'importe quoi d'unique
      - La valeur main de aName est réservée et permet de filtrer au niveau du wizard.
      - D'autre valeurs sont utilisées de la même façon au niveau des wizards pour Applet, Servlet, Factory.
      - Exemple :
        <aw:method name="toString"> /** * Returns a string representation of the object. In general, the * toString method returns a string that * " textually represents " this object. * * @return a string representation of the object. */ public String toString() { StringBuffer sb = new StringBuffer(); sb.append('['); sb.append(getClass()); sb.append(']'); return sb.toString(); } </aw:method>
    - Code Statique :
      - Il n'y a pas de tag particulier pour ajouter du code statique, mais voici comment faire.
      - Vous pouvez ajouter des bloques statiques via/avec une méthode ou un constructeur ou un attribut.
      - Exemple avec un constructeur :
        <aw:constructor name="C1"> /** * Constructor of the object. */ public <aw:className/>() { super(); } static { System.out.println("Yes"); } </aw:constructor>
      - Exemple avec un attribut :
        <aw:field> /** This is the array of object. */ protected <aw:containedTypeEntered/>[] itsArray; static { System.out.println("Yes"); } </aw:field>
  - Dans le cas des list/array/set/map :
    - Tokens particuliers :
      - <aw:listType/> : représente le nom de la classe implémentant l'interface java.util.List.
      - <aw:mapType/> : représente le nom de la classe implémentant l'interface java.util.Map.
      - <aw:setType/> : représente le nom de la classe implémentant l'interface java.util.Set.
      - <aw:containedTypeEntered/> : sera remplacé par la valeur entrée par l'utilisateur dans le Wizard comme contenu de la liste/tableau/set ou valeur du dictionnaire
      - <aw:containedTypeClassName/> : sera remplacé par le nom de la classe représentant le contenu de la liste/tableau/set ou valeur du dictionnaire.
        Si <aw:containedTypeEntered/> vaut int alors <aw:containedTypeClassName/> vaut Integer.
        Si <aw:containedTypeEntered/> vaut java.lang.String alors <aw:containedTypeClassName/> vaut java.lang.String.
      - <aw:containedTypeAsNull/> : sera remplacé par la valeur null de la classe représentant le contenu de liste/tableau/set ou valeur du dictionnaire.
        Si <aw:containedTypeEntered/> vaut int alors <aw:containedTypeClassName/> vaut Integer.MIN_VALUE.
        Si <aw:containedTypeEntered/> vaut java.lang.String alors <aw:containedTypeClassName/> vaut null.
      - <aw:containedKeyEntered/> : comme <aw:containedTypeEntered/> mais représente la clef du dictionnaire.
      - <aw:containedKeyClassName/> : comme <aw:containedTypeClassName/> mais représente la clef du dictionnaire.
      - <aw:containedKeyAsNull/> : comme <aw:containedTypeAsNull/> mais représente la clef du dictionnaire.
    - Transformateurs :
      - <aw:containedTypeAsValue>value</aw:containedTypeAsValue> : Utilisez pour les structures qui contiennent des wrappeurs que l'on veut sous forme de type simple.
        Exemple : si l'ArrayList contient des int, ils sont wrappés sous forme de Integer. En ecrivant <aw:containedTypeAsValue>anElement</aw:containedTypeAsValue> on obtient le code anElement.intValue().
        Ne fait rien si le contenu de l'ArrayList est de type Object.
      - <aw:containedKeyAsValue>value</aw:containedKeyAsValue> : idem, mais pour les clefs des dictionnaires.
      - <aw:containedTypeAsObject>value</aw:containedTypeAsObject> : Transforme un type de base en son wrappeur.
        Exemple : si l'ArrayList contient des int, ils doivent être wrappés sous forme de Integer. En ecrivant <aw:containedTypeAsObject>anElement</aw:containedTypeAsObject> on obtient le code new Integer(anElement).
        Ne fait rien si le contenu de l'ArrayList est de type Object.
      - <aw:containedKeyAsObject>value</aw:containedKeyAsObject> : idem, mais pour les clefs des dictionnaires.
      - Attention : N'imbriquez pas les transformateurs entre eux.
- Toute modification des templates, est automatiquement prise en compte, il n'est pas nécessaire de re-démarrer Eclipse.
Modifier le fichier templates_fr.properties qui se trouvent dans le répertoire [InstallEclipse]/plugins/com.aston.plugins
- Ajouter une entrée dans ce fichier
  - Dans le cas d'un template pour une page JSP :
    jsp.template.3=nomDuFichier
    jsp.template.3.label=Label pour Eclipse
  - Dans le cas d'un template pour une page HTML :
    html.template.3=nomDuFichier
    html.template.3.label=Label pour Eclipse
  - Dans le cas d'un template pour une page HTML qui lance une applet :
    applethtml.template.2=nomDuFichier
    applethtml.template.2.label=Label pour Eclipse
  - ATTENTION : Dans tous les cas les chiffres doivent se suivre.
  - 'nomDuFichier' représente le nom d'un fichier avec son extension
  - 'Label pour Eclipse' représente la chaîne de caractère que vous montrera Eclipse
- Ajouter une implémentation de structure.
  - Si vous souhaitez ajouter des implémentation pour l'interface List, Set, Map vous devez le faire à l'intérieur du fichier templates_fr.properties.
  - Par exemple, dans le cas d'une Map, il suffit d'ajouter une ligne :
    struct.map.6=java.util.IdentityHashMap
    Cette ligne représente un nom de clef : struct.map.6, qui doit être unique dans tout le fichier.
    Suivit par le nom complet d'une classe : java.util.IdentityHashMap
Si vous touchez au fichier templates.properties pendant que Eclipse est démarré il faut l'arrêter et le re-démarrer.