IdentifiantMot de passe
Loading...
Mot de passe oublié ?Je m'inscris ! (gratuit)
Navigation

Inscrivez-vous gratuitement
pour pouvoir participer, suivre les réponses en temps réel, voter pour les messages, poser vos propres questions et recevoir la newsletter

Eclipse Platform Discussion :

Ajouter des infos à l'infobulle de la Javadoc


Sujet :

Eclipse Platform

  1. #1
    Membre averti
    Homme Profil pro
    Ingénieur développement logiciels
    Inscrit en
    octobre 2005
    Messages
    215
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 36
    Localisation : France, Ain (Rhône Alpes)

    Informations professionnelles :
    Activité : Ingénieur développement logiciels
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : octobre 2005
    Messages : 215
    Points : 435
    Points
    435
    Par défaut Ajouter des infos à l'infobulle de la Javadoc
    Bonjour,

    Sur Eclipse Mars.1, je souhaiterais, pour une fonction particulière, afficher dans l'éditeur Java en infobulle sur une fonction, des informations particulières (en plus ou à la place de la javadoc).

    Je m'explique : cette fonction particulière, getLabel, est appelée à plein d'endroits dans mon application et a pour but d'aller chercher un libellé à partir d'un code et de le retourner. L'idée serait d'avoir dans le code un moyen simple de pouvoir voir quel libellé est utilisé.

    Par exemple, si je fais System.out.println(getLabel("toto.titi")); avoir dans l'infobulle qui apparait sur getLabel la valeur du libellé toto.titi.

    J'étais parti sur l'idée de créer une annotation, mais je ne vois pas bien comment m'en sortir (et je doute même que ce soit la bonne piste).
    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    3
    4
    5
    6
    7
    package com.giragu03.test.annotations;
    import java.lang.annotation.Documented;
    @Documented
     
    public @interface Label {
        String value();
    }
    Là, je peux ajouter l'annotation autour de getLabel :
    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    3
    4
    @Label("test")
    final public String getLabel(String labelpath) {
        return labelpath + ".tutu"; // le traitement réel est une requête sql
    }
    Mais ça ne m'avance pas beaucoup, parce qu'au final j'ai dans l'infobulle @Label(value="test") alors que je voudrais avoir l'information toto.titi.tutu.

    Je ne sais pas s'il est possible d'utiliser le paramètre "labelpath" passé à la méthode (mais même dans ce cas, je ne vois pas comment pouvoir faire afficher la valeur que retourne getLabel pour labelpath).

    L'autre piste que j'avais, c'était de partir sur un plugin. J'ai déjà créé une vue dans Eclipse qui permet de rechercher la valeur d'un libellé à partir de son labelpath et de retrouver le labelpath à partir d'un morceau du libellé. Mais pour manipuler les infobulles du Java Editor, je ne vois pas bien : faudrait-il que je surcharge celui-ci ?

    Merci d'avance à tous ceux qui pourront m'orienter sur la marche à suivre, sachant que la manière de stocker les libellés ne peut être changée (ils sont en base de données et il faut une requête SQL pour y accéder).
    « Pourquoi faire simple quand on peut faire compliqué ? » (Deuxième principe fondamental de la logique Shadok)

  2. #2
    Modérateur
    Avatar de joel.drigo
    Homme Profil pro
    Ingénieur R&D - Développeur Java
    Inscrit en
    septembre 2009
    Messages
    12 430
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 52
    Localisation : France, Paris (Île de France)

    Informations professionnelles :
    Activité : Ingénieur R&D - Développeur Java
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : septembre 2009
    Messages : 12 430
    Points : 29 095
    Points
    29 095
    Billets dans le blog
    2
    Par défaut
    Salut,

    La classe qui génère les infobulles de JavaDoc n'est visiblement (à la lecture du code) pas prévue pour être extensible. On peut remplacer l'infobulle par sa propre infobulle, en utilisant l'extension org.eclipse.jdt.ui.javaEditorTextHovers, et en implémentant org.eclipse.jdt.ui.text.java.hover.IJavaEditorTextHover.

    On peut contourner çà, en faisant quelque chose qui est déconseillé, mais qui est possible : en étendant la classe qui génère l'infobulle de l'éditeur Java de Eclipse. il faut juste savoir que la classe peut être modifiée dans une version ultérieure d'Eclipse et que ton code pourra ne plus fonctionner alors.

    La classe est org.eclipse.jdt.internal.ui.text.java.hover.JavadocHover. La méthode à redéfinir est getHoverInfo2(ITextViewer textViewer, IRegion hoverRegion). La méthode retourne une instance de org.eclipse.jdt.internal.ui.text.java.hover.JavadocBrowserInformationControlInput, qui est un encapsuleur de html. En récupérant cet html, tu peux inclure dedans ce que tu veux. Par l'AST, tu pourraas tester l'élément survolé, et adapter le texte.

    Par exemple, en utilisant JSoup, je peux ajouter mon texte à la fin du body, pour les méthodes seulement (je retourne une autre instance de l'encapsuleur, par cohérence, mais on pourrait retourner du String directement sans problème) :

    Code : Sélectionner tout - Visualiser dans une fenêtre à part
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    	@Override
    	public Object getHoverInfo2(ITextViewer textViewer, IRegion hoverRegion) {
    		final Object object = super.getHoverInfo2(textViewer, hoverRegion);
    		if ( object instanceof JavadocBrowserInformationControlInput ) {
    			final IJavaElement[] elements = getJavaElementsAt(textViewer, hoverRegion);
    			if ( elements.length>0 && elements[0] instanceof IMethod ) {
    				JavadocBrowserInformationControlInput htmlTooltip = (JavadocBrowserInformationControlInput) object;
    				final String html = htmlTooltip.getHtml();
    				final Document document = Jsoup.parse(html);
    				document.getElementsByTag("body").append("<p>Tooltip ... au sujet de <b>"+elements[0].getElementName()+"</b>....</p>");
    				return new JavadocBrowserInformationControlInput(null, htmlTooltip.getElement(), document.html(), htmlTooltip.getLeadingImageWidth());
    			}
    		}
    		return null;
    	}
    L'expression "ça marche pas" ne veut rien dire. Indiquez l'erreur, et/ou les comportements attendus et obtenus, et donnez un Exemple Complet Minimal qui permet de reproduire le problème.
    La plupart des réponses à vos questions sont déjà dans les FAQs ou les Tutoriels, ou peut-être dans une autre discussion : utilisez la recherche interne.
    Des questions sur Java : consultez le Forum Java. Des questions sur l'EDI Eclipse ou la plateforme Eclipse RCP : consultez le Forum Eclipse.
    Une question correctement posée et rédigée et vous aurez plus de chances de réponses adaptées et rapides.
    N'oubliez pas de mettre vos extraits de code entre balises CODE (Voir Mode d'emploi de l'éditeur de messages).
    Nouveau sur le forum ? Consultez Les Règles du Club.

  3. #3
    Membre averti
    Homme Profil pro
    Ingénieur développement logiciels
    Inscrit en
    octobre 2005
    Messages
    215
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 36
    Localisation : France, Ain (Rhône Alpes)

    Informations professionnelles :
    Activité : Ingénieur développement logiciels
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : octobre 2005
    Messages : 215
    Points : 435
    Points
    435
    Par défaut
    Salut,
    Merci beaucoup pour ces informations. Je ne vais pas avoir trop le temps de me remettre sur le sujet dans les jours à venir (il faut bien comprendre que je n'ai pas de temps de planifié pour ce genre de tâches et que ça se fait entre deux), mais tes explications me semblent très claires et correspondent bien à ce que je veux faire.
    Je te tiendrai au courant quand j'aurai pu avancer sur le sujet.
    Merci encore.
    « Pourquoi faire simple quand on peut faire compliqué ? » (Deuxième principe fondamental de la logique Shadok)

  4. #4
    Membre averti
    Homme Profil pro
    Ingénieur développement logiciels
    Inscrit en
    octobre 2005
    Messages
    215
    Détails du profil
    Informations personnelles :
    Sexe : Homme
    Âge : 36
    Localisation : France, Ain (Rhône Alpes)

    Informations professionnelles :
    Activité : Ingénieur développement logiciels
    Secteur : High Tech - Éditeur de logiciels

    Informations forums :
    Inscription : octobre 2005
    Messages : 215
    Points : 435
    Points
    435
    Par défaut
    Salut joel.drigo,
    J'ai réussi à trouver un peu de temps pour me pencher à nouveau sur le sujet.
    Je te confirme que j'arrive à afficher l'info-bulle avec les infos qui vont bien.
    Merci beaucoup car je n'y serais pas arrivé tout seul.
    « Pourquoi faire simple quand on peut faire compliqué ? » (Deuxième principe fondamental de la logique Shadok)

+ Répondre à la discussion
Cette discussion est résolue.

Discussions similaires

  1. Ajouter des infos cachées dans une image
    Par rambc dans le forum Général Python
    Réponses: 6
    Dernier message: 24/06/2009, 18h48
  2. Réponses: 3
    Dernier message: 02/12/2008, 14h29
  3. Ajouter des infos cron.daily
    Par info_alex dans le forum Administration système
    Réponses: 2
    Dernier message: 24/06/2008, 08h38
  4. comment ajouter des infos projet sur mes JSP
    Par legad dans le forum Maven
    Réponses: 1
    Dernier message: 12/02/2008, 16h45
  5. Réponses: 1
    Dernier message: 23/08/2007, 23h38

Partager

Partager
  • Envoyer la discussion sur Viadeo
  • Envoyer la discussion sur Twitter
  • Envoyer la discussion sur Google
  • Envoyer la discussion sur Facebook
  • Envoyer la discussion sur Digg
  • Envoyer la discussion sur Delicious
  • Envoyer la discussion sur MySpace
  • Envoyer la discussion sur Yahoo