Graph Database Console result UX improvements (#123)

* Make clear when Graph tab is empty, but results are available on Table tab

Author: dwitry

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/console/graph/GraphPanel.java

@@ -6,6 +6,8 @@
 import com.intellij.ui.ColorUtil;
 import com.intellij.ui.awt.RelativePoint;
 import com.intellij.ui.components.JBLabel;
+import com.intellij.ui.components.labels.LinkLabel;
+import com.intellij.ui.components.labels.LinkListener;
 import com.intellij.ui.popup.BalloonPopupBuilderImpl;
 import com.intellij.ui.treeStructure.PatchedDefaultMutableTreeNode;
 import com.intellij.ui.treeStructure.Tree;
@@ -18,9 +20,10 @@
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.component.datasource.state.DataSourceApi;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.GraphConsoleView;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.event.QueryExecutionProcessEvent;
-import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.datasource.tree.TreeContextMenuMouseAdapter;
+import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.datasource.tree.TreeMouseAdapter;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.helpers.UiHelper;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.renderes.tree.PropertyTreeCellRenderer;
+import com.neueda.jetbrains.plugin.graphdb.platform.GraphConstants.ToolWindow.Tabs;
 import com.neueda.jetbrains.plugin.graphdb.visualization.PrefuseVisualization;
 import com.neueda.jetbrains.plugin.graphdb.visualization.services.LookAndFeelService;
 import prefuse.visual.VisualItem;
@@ -31,6 +34,7 @@
 import java.awt.event.MouseEvent;
 import java.util.Enumeration;
 
+import static com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.event.OpenTabEvent.*;
 import static com.neueda.jetbrains.plugin.graphdb.visualization.util.DisplayUtil.*;
 
 public class GraphPanel {
@@ -53,7 +57,7 @@ public void initialize(GraphConsoleView graphConsoleView, Project project) {
         MessageBus messageBus = project.getMessageBus();
         this.lookAndFeelService = graphConsoleView.getLookAndFeelService();
         this.entityDetailsTree = graphConsoleView.getEntityDetailsTree();
-        entityDetailsTree.addMouseListener(new TreeContextMenuMouseAdapter());
+        entityDetailsTree.addMouseListener(new TreeMouseAdapter());
 
         // Bootstrap visualisation
         visualization = new PrefuseVisualization(lookAndFeelService);
@@ -71,8 +75,12 @@ public void executionStarted(DataSourceApi dataSource, ExecuteQueryPayload paylo
 
             @Override
             public void resultReceived(ExecuteQueryPayload payload, GraphQueryResult result) {
-                if (result.getNodes().isEmpty()) {
-                    entityDetailsTreeModel.setRoot(null);
+                if (result.getNodes().isEmpty() && !result.getRows().isEmpty()) {
+                    LinkListener<?> openTableTab = (l, s) -> messageBus.syncPublisher(OPEN_TAB_TOPIC).openTab(Tabs.TABLE);
+                    LinkLabel<?> link = new LinkLabel<>("Nothing to display in Graph. Click to view results as Table.", null, openTableTab);
+                    entityDetailsTreeModel.setRoot(new PatchedDefaultMutableTreeNode(link));
+                } else if (result.getNodes().isEmpty()) {
+                    entityDetailsTreeModel.setRoot(new PatchedDefaultMutableTreeNode("Query returned no results."));
                 } else {
                     entityDetailsTreeModel.setRoot(new PatchedDefaultMutableTreeNode("Select an item in the graph to view details..."));
                 }

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/console/log/LogPanel.java

@@ -60,11 +60,15 @@ public void resultReceived(ExecuteQueryPayload payload, GraphQueryResult result)
                 info(String.format("Query executed in %sms. %s", result.getExecutionTimeMs(), result.getResultSummary()));
                 if (result.getRows().isEmpty()) {
                     info("No results.");
+                } else if (result.getNodes().isEmpty()) {
+                    info(String.format("Got %s rows. View results: %s",
+                            result.getRows().size(),
+                            GoToTabFilter.TABLE_TAB_LINK));
                 } else {
                     info(String.format("Got %s rows. View results: %s, %s",
-                        result.getRows().size(),
-                        GoToTabFilter.GRAPH_TAB_LINK,
-                        GoToTabFilter.TABLE_TAB_LINK));
+                            result.getRows().size(),
+                            GoToTabFilter.GRAPH_TAB_LINK,
+                            GoToTabFilter.TABLE_TAB_LINK));
                 }
                 newLine();
             }

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/console/table/ValueConverter.java

@@ -3,17 +3,15 @@
 import com.intellij.ui.treeStructure.PatchedDefaultMutableTreeNode;
 import com.intellij.ui.treeStructure.Tree;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.component.datasource.state.DataSourceApi;
-import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.datasource.tree.TreeContextMenuMouseAdapter;
+import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.datasource.tree.TreeMouseAdapter;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.renderes.tree.PropertyTreeCellRenderer;
 
 import javax.swing.event.TreeExpansionEvent;
 import javax.swing.event.TreeExpansionListener;
 import javax.swing.tree.DefaultTreeModel;
 import java.util.Objects;
 
-import static com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.helpers.UiHelper.canBeTree;
-import static com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.helpers.UiHelper.keyValueToTreeNode;
-import static com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.helpers.UiHelper.representUiString;
+import static com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.helpers.UiHelper.*;
 
 public class ValueConverter {
 
@@ -50,7 +48,7 @@ public void treeCollapsed(TreeExpansionEvent event) {
             }
         });
 
-        tree.addMouseListener(new TreeContextMenuMouseAdapter());
+        tree.addMouseListener(new TreeMouseAdapter());
 
         treeModel.reload();
         return tree;

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/datasource/DataSourcesView.java

@@ -22,11 +22,10 @@
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.util.FileUtil;
 import com.neueda.jetbrains.plugin.graphdb.language.cypher.completion.metadata.CypherMetadataProviderService;
 
-import javax.swing.BorderFactory;
-import javax.swing.JPanel;
+import javax.swing.*;
 import javax.swing.tree.DefaultMutableTreeNode;
 import javax.swing.tree.DefaultTreeModel;
-import java.awt.GridLayout;
+import java.awt.*;
 import java.io.IOException;
 import java.util.Enumeration;
 import java.util.List;
@@ -111,7 +110,7 @@ private void configureDataSourceTree() {
         dataSourceTree.setModel(treeModel);
         dataSourceTree.setRootVisible(false);
         dataSourceTree.setToggleClickCount(0);
-        dataSourceTree.addMouseListener(new TreeContextMenuMouseAdapter());
+        dataSourceTree.addMouseListener(new TreeMouseAdapter());
     }
 
     private void decorateDataSourceTree() {

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/datasource/tree/TreeContextMenuMouseAdapter.java

@@ -0,0 +1,44 @@
+package com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.datasource.tree;
+
+import com.intellij.ide.DataManager;
+import com.intellij.openapi.actionSystem.DataContext;
+import com.intellij.ui.components.labels.LinkLabel;
+import com.intellij.ui.treeStructure.PatchedDefaultMutableTreeNode;
+import com.intellij.ui.treeStructure.Tree;
+
+import javax.swing.*;
+import javax.swing.tree.TreePath;
+import java.awt.event.MouseAdapter;
+import java.awt.event.MouseEvent;
+import java.util.Optional;
+
+public class TreeMouseAdapter extends MouseAdapter {
+
+    private ContextMenuService contextMenuService = new ContextMenuService();
+
+    @Override
+    public void mouseClicked(MouseEvent e) {
+        Tree tree = (Tree) e.getComponent();
+        TreePath pathForLocation = tree.getPathForLocation(e.getX(), e.getY());
+
+        if (SwingUtilities.isLeftMouseButton(e)) {
+            Optional.ofNullable(pathForLocation)
+                    .flatMap(p -> cast(p.getLastPathComponent(), PatchedDefaultMutableTreeNode.class))
+                    .flatMap(n -> cast(n.getUserObject(), LinkLabel.class))
+                    .ifPresent(LinkLabel::doClick);
+        } else if (SwingUtilities.isRightMouseButton(e)) {
+            DataContext dataContext = DataManager.getInstance().getDataContext(tree);
+            contextMenuService.getContextMenu(pathForLocation)
+                    .ifPresent(dto -> dto.showPopup(dataContext));
+        }
+    }
+
+    @SuppressWarnings("unchecked")
+    private <T> Optional<T> cast(Object o, Class<T> clazz) {
+        if (clazz.isInstance(o)) {
+            return Optional.of((T) o);
+        } else {
+            return Optional.empty();
+        }
+    }
+}

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/datasource/tree/TreeMouseAdapter.java

@@ -2,6 +2,7 @@
 
 import com.intellij.ui.ColoredTreeCellRenderer;
 import com.intellij.ui.SimpleTextAttributes;
+import com.intellij.ui.components.labels.LinkLabel;
 import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.datasource.tree.TreeNodeModelApi;
 import org.jetbrains.annotations.NotNull;
 
@@ -25,6 +26,9 @@ public void customizeCellRenderer(@NotNull JTree tree, Object value, boolean sel
                     append(model.getValue().get().toString());
                 }
             }
+        } else if (userObject instanceof LinkLabel) {
+            String text = ((LinkLabel) userObject).getText();
+            append(text, SimpleTextAttributes.LINK_ATTRIBUTES);
         } else if (userObject != null) {
             append(userObject.toString());
         }