Autopopup on CTRL + mouse over

Answered

Created June 25, 2019 08:30

Hi all,

I want to extend a plugin I wrote to have the same behavior as the CTRL + mouse over on variables.

The company I work for is using it own way of handling translations (i wished they used I18n... but that's another topic)

All translations are always of a specific class, let say MyTranslation with names in form MY_TRANSLATED_KEY_TXT

(note that all keys always end with _TXT)

and the translation value is located in a file with a speficic extention in the same folder as the java file.

so basicly my idea was to somehow make an autopup appear that displays the translated text like intellij would do with normal I18n translations.

The logic should be like that

take the name of the element bellow the mouse and check if it matches a specif regex (easy)

optional maybe check also that the name is an instance of right class (i managed to get the psiElement under the caret but have no idea how to get the class of the variable.. )

if it is the case, read the translation from the file (the key is the same as the selected name) (should not be a big issue)

and finaly popup the translation like it is done for i18n

Unfortunately I have no idea where to look for this last part. Any clue or code example I could use ?

Of course currently if i do CRTL + hover on the translation key, it shows me where it is instanciated, as this is java code :/

8 comments

Yann Cebron

Created June 25, 2019 12:34

A simple version would be (if I understand the setup correctly) to provide com.intellij.lang.documentation.DocumentationProvider#getQuickNavigateInfo that works on such field references and simply performs resolving to the real key -> real value in this method. see http://www.jetbrains.org/intellij/sdk/docs/reference_guide/custom_language_support/documentation.html

Alain Tavan

Created June 25, 2019 15:42

I did following

public class TranslationDocumentationProvider extends JavaDocumentationProvider
{

@Override
@Nullable
public String getQuickNavigateInfo(PsiElement element, PsiElement originalElement) {
   if(isCompanyMultiLang(element)) { //the method is working, but i don't know how to make the plugin get here
      return "Translated text will be shown here"; //will be replaced by the correct code that is already ready
   }else{
      return super.getQuickNavigateInfo(element, originalElement);
   }
}
}

but now I need to tell IntelliJ to use my own JavaDocumentationProvider, that of course will do the same as the defaut one if it is not a company class translation.

I modified my plugin.xml,

<extensions defaultExtensionNs="com.intellij">
    <lang.documentationProvider language="JAVA" implementation="com.swissas.provider.TranslationDocumentationProvider" />
</extensions>

OR

<extensions defaultExtensionNs="com.intellij">
<documentationProvider implementation="com.swissas.provider.TranslationDocumentationProvider" />
</extensions>

but none works :/
The first gives me an exception, and the second one does not change anything

if you have any more help I would really appreciate it :)

Best regards,

Alain

Yann Cebron

Created June 25, 2019 15:44

Please add order="first" to your registration of "<lang.documentationProvider ..." in plugin.xml. This will make sure your provider is tried first before that "regular" Java one.

Alain Tavan

Created June 25, 2019 16:12

You're amazing thanks a lot :P

Alain Tavan

Created June 26, 2019 08:48

By the way, is it possible to do the same within javadoc ?

Indeed in the company I work for, we are using shortCode as author and i wanted to have the same possibility on the author value to display informations about the user (full name, phone, mail)

I put a breakpoint on the getQuickNavigateInfo but it does not seems to go in

Any way of doing that ?

Best regards,

Alain