Discussion :

[giragu03]

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).

[joel.drigo]

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;
	}

[giragu03]

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.

[giragu03]

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.