Merge pull request #1808 from Haehnchen/feature/status-bar-migrate

migrate Symfony statusbar to extension

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/Symfony2ProjectComponent.java

@@ -8,15 +8,12 @@
 import com.intellij.openapi.extensions.ExtensionPointName;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.vfs.VfsUtil;
-import com.intellij.openapi.wm.StatusBar;
-import com.intellij.openapi.wm.WindowManager;
 import com.intellij.psi.PsiElement;
 import fr.adrienbrault.idea.symfony2plugin.dic.ContainerFile;
 import fr.adrienbrault.idea.symfony2plugin.dic.container.util.ServiceContainerUtil;
 import fr.adrienbrault.idea.symfony2plugin.extension.PluginConfigurationExtension;
 import fr.adrienbrault.idea.symfony2plugin.extension.ServiceContainerLoader;
 import fr.adrienbrault.idea.symfony2plugin.extension.ServiceContainerLoaderParameter;
-import fr.adrienbrault.idea.symfony2plugin.profiler.widget.SymfonyProfilerWidget;
 import fr.adrienbrault.idea.symfony2plugin.routing.RouteHelper;
 import fr.adrienbrault.idea.symfony2plugin.util.IdeHelper;
 import fr.adrienbrault.idea.symfony2plugin.util.ProjectUtil;
@@ -38,50 +35,22 @@ public class Symfony2ProjectComponent implements ProjectComponent {
     private static final ExtensionPointName<ServiceContainerLoader> SERVICE_CONTAINER_POINT_NAME = new ExtensionPointName<>("fr.adrienbrault.idea.symfony2plugin.extension.ServiceContainerLoader");
     public static final ExtensionPointName<PluginConfigurationExtension> PLUGIN_CONFIGURATION_EXTENSION = new ExtensionPointName<>("fr.adrienbrault.idea.symfony2plugin.extension.PluginConfigurationExtension");
 
-    private Project project;
+    private final Project project;
 
     public Symfony2ProjectComponent(Project project) {
         this.project = project;
     }
 
-    public void initComponent() {
-        //System.out.println("initComponent");
-    }
-
-    public void disposeComponent() {
-        //System.out.println("disposeComponent");
-    }
-
     @NotNull
     public String getComponentName() {
         return "Symfony2ProjectComponent";
     }
 
-
-
     public void projectOpened() {
         this.checkProject();
-
-        // attach toolbar popup (right bottom)
-        StatusBar statusBar = WindowManager.getInstance().getStatusBar(this.project);
-        if(statusBar == null) {
-            return;
-        }
-
-        // clean bar on project open; we can have multiple projects att some time
-        if(statusBar.getWidget(SymfonyProfilerWidget.ID) != null) {
-            statusBar.removeWidget(SymfonyProfilerWidget.ID);
-        }
-
-        if(isEnabled()) {
-            SymfonyProfilerWidget symfonyProfilerWidget = new SymfonyProfilerWidget(this.project);
-            statusBar.addWidget(symfonyProfilerWidget);
-        }
-
     }
 
     public void projectClosed() {
-
         ServiceXmlParserFactory.cleanInstance(project);
 
         // clean routing
@@ -99,7 +68,7 @@ public void showInfoNotification(String content) {
         Notifications.Bus.notify(errorNotification, this.project);
     }
 
-    public boolean isEnabled() {
+    private boolean isEnabled() {
         return Settings.getInstance(project).pluginEnabled;
     }
 

src/main/java/fr/adrienbrault/idea/symfony2plugin/ui/SymfonyStatusbarWidgetFactory.java

@@ -0,0 +1,49 @@
+package fr.adrienbrault.idea.symfony2plugin.ui;
+
+import com.intellij.openapi.project.Project;
+import com.intellij.openapi.util.Disposer;
+import com.intellij.openapi.wm.StatusBar;
+import com.intellij.openapi.wm.StatusBarWidget;
+import com.intellij.openapi.wm.StatusBarWidgetFactory;
+import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
+import fr.adrienbrault.idea.symfony2plugin.profiler.widget.SymfonyProfilerWidget;
+import org.jetbrains.annotations.Nls;
+import org.jetbrains.annotations.NonNls;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * @author Daniel Espendiller <[email protected]>
+ */
+public class SymfonyStatusbarWidgetFactory implements StatusBarWidgetFactory {
+    @Override
+    public @NonNls
+    @NotNull String getId() {
+        return "symfony.status.bar";
+    }
+
+    @Override
+    public @Nls
+    @NotNull String getDisplayName() {
+        return "Symfony";
+    }
+
+    @Override
+    public boolean isAvailable(@NotNull Project project) {
+        return Symfony2ProjectComponent.isEnabled(project);
+    }
+
+    @Override
+    public @NotNull StatusBarWidget createWidget(@NotNull Project project) {
+        return new SymfonyProfilerWidget(project);
+    }
+
+    @Override
+    public void disposeWidget(@NotNull StatusBarWidget statusBarWidget) {
+        Disposer.dispose(statusBarWidget);
+    }
+
+    @Override
+    public boolean canBeEnabledOn(@NotNull StatusBar statusBar) {
+        return true;
+    }
+}

src/main/resources/META-INF/plugin.xml

@@ -250,6 +250,8 @@
         <multiHostInjector implementation="fr.adrienbrault.idea.symfony2plugin.lang.ParameterLanguageInjector"/>
         <iconProvider implementation="fr.adrienbrault.idea.symfony2plugin.twig.icon.TwigIconProvider"/>
 
+        <statusBarWidgetFactory implementation="fr.adrienbrault.idea.symfony2plugin.ui.SymfonyStatusbarWidgetFactory" />
+
         <localInspection groupPath="Symfony" shortName="PhpRouteMissingInspection" displayName="Route Missing"
                          groupName="Route"
                          enabledByDefault="true" level="WARNING"