Provide new presentation model for the tree node (eclipse-che#6718)

* Provide new presentation model for the tree node

Signed-off-by: Vladyslav Zhukovskyi <vzhukovs@redhat.com>

* Add missing HasNewPresentation interface

Signed-off-by: Vladyslav Zhukovskyi <vzhukovs@redhat.com>

Author: vzhukovs

ide/che-core-ide-ui/src/main/java/org/eclipse/che/ide/ui/smartTree/presentation/DefaultPresentationRenderer.java

@@ -10,6 +10,8 @@
  */
 package org.eclipse.che.ide.ui.smartTree.presentation;
 
+import static com.google.common.base.Strings.nullToEmpty;
+
 import com.google.common.base.Strings;
 import com.google.gwt.dom.client.DivElement;
 import com.google.gwt.dom.client.Document;
@@ -28,14 +30,55 @@ public DefaultPresentationRenderer(TreeStyles treeStyles) {
 
   @Override
   public Element render(N node, String domID, Tree.Joint joint, int depth) {
-    NodePresentation presentation;
-    if (node instanceof HasPresentation) {
-      presentation = ((HasPresentation) node).getPresentation(false);
+
+    if (node instanceof HasNewPresentation) {
+      NewNodePresentation presentation = ((HasNewPresentation) node).getPresentation();
+
+      return renderNewPresentation(presentation, domID, joint, depth);
+    } else if (node instanceof HasPresentation) {
+      NodePresentation presentation = ((HasPresentation) node).getPresentation(false);
+
+      return renderGenericPresentation(presentation, domID, joint, depth);
     } else {
-      presentation = new NodePresentation();
+      NodePresentation presentation = new NodePresentation();
       presentation.setPresentableText(node.getName());
+
+      return renderGenericPresentation(presentation, domID, joint, depth);
     }
+  }
 
+  Element renderNewPresentation(
+      NewNodePresentation presentation, String domID, Tree.Joint joint, int depth) {
+    Element rootContainer = getRootContainer(domID);
+    Element nodeContainer = getNodeContainer();
+    setIndentLevel(nodeContainer, depth);
+    Element jointContainer = getJointContainer(joint);
+    Element iconContainer = getIconContainer(presentation.getIcon());
+    Element userElement = getUserElement(presentation.getUserElement());
+    Element presentableTextContainer =
+        getPresentableTextContainer(
+            createStyledTextElement(presentation.getNodeText(), presentation.getNodeTextStyle()));
+    Element infoTextContainer =
+        getInfoTextContainer(
+            createStyledTextElement(
+                presentation.getNodeInfoText(), presentation.getNodeInfoTextStyle()));
+    Element descendantsContainer = getDescendantsContainer();
+
+    nodeContainer.appendChild(jointContainer);
+    nodeContainer.appendChild(iconContainer);
+    nodeContainer.appendChild(
+        userElement == null ? Document.get().createSpanElement() : userElement);
+    nodeContainer.appendChild(presentableTextContainer);
+    nodeContainer.appendChild(infoTextContainer);
+
+    rootContainer.appendChild(nodeContainer);
+    rootContainer.appendChild(descendantsContainer);
+
+    return rootContainer;
+  }
+
+  Element renderGenericPresentation(
+      NodePresentation presentation, String domID, Tree.Joint joint, int depth) {
     Element rootContainer = getRootContainer(domID);
 
     Element nodeContainer = getNodeContainer();
@@ -68,10 +111,24 @@ public Element render(N node, String domID, Tree.Joint joint, int depth) {
     return rootContainer;
   }
 
+  private Element createStyledTextElement(String content, StyleConfigurator styleConfigurator) {
+    DivElement textElement = Document.get().createDivElement();
+
+    textElement.setInnerText(nullToEmpty(content));
+
+    if (styleConfigurator != null) {
+      styleConfigurator
+          .getCssConfiguration()
+          .forEach((p, v) -> textElement.getStyle().setProperty(p, v));
+    }
+
+    return textElement;
+  }
+
   private Element createPresentableTextElement(NodePresentation presentation) {
     DivElement textElement = Document.get().createDivElement();
 
-    textElement.setInnerText(Strings.nullToEmpty(presentation.getPresentableText()));
+    textElement.setInnerText(nullToEmpty(presentation.getPresentableText()));
     textElement.setAttribute("style", presentation.getPresentableTextCss());
 
     //TODO support text colorization

ide/che-core-ide-ui/src/main/java/org/eclipse/che/ide/ui/smartTree/presentation/HasNewPresentation.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2012-2017 Red Hat, Inc.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.ide.ui.smartTree.presentation;
+
+/**
+ * Provider for the new type of presentation represented by {@link NewNodePresentation}.
+ *
+ * @author Vlad Zhukovskyi
+ * @since 5.19.0
+ */
+public interface HasNewPresentation {
+
+  /**
+   * Returns a new type of node presentation.
+   *
+   * @return presentation
+   * @see NewNodePresentation
+   */
+  NewNodePresentation getPresentation();
+}

ide/che-core-ide-ui/src/main/java/org/eclipse/che/ide/ui/smartTree/presentation/HasPresentation.java

@@ -17,7 +17,9 @@
  * node icon, presentable text, info text, etc.
  *
  * @author Vlad Zhukovskiy
+ * @deprecated use {@link HasNewPresentation} instead
  */
+@Deprecated
 public interface HasPresentation {
   /**
    * Method called during node rendering.

ide/che-core-ide-ui/src/main/java/org/eclipse/che/ide/ui/smartTree/presentation/NewNodePresentation.java

@@ -0,0 +1,110 @@
+/*
+ * Copyright (c) 2012-2017 Red Hat, Inc.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.ide.ui.smartTree.presentation;
+
+import com.google.gwt.dom.client.Element;
+import org.vectomatic.dom.svg.ui.SVGResource;
+
+/**
+ * Node presentation which contains a useful builder to friendly build the presentation. Node which
+ * should provide a new type of presentation should implement a {@link HasNewPresentation}
+ * interface.
+ *
+ * @author Vlad Zhukovskyi
+ * @since 5.19.0
+ */
+public class NewNodePresentation {
+
+  private String nodeText;
+  private StyleConfigurator nodeTextStyle;
+  private String nodeInfoText;
+  private StyleConfigurator nodeInfoTextStyle;
+  private SVGResource icon;
+  private Element userElement;
+
+  private NewNodePresentation(Builder builder) {
+    this.nodeText = builder.nodeText;
+    this.nodeTextStyle = builder.nodeTextStyle;
+    this.nodeInfoText = builder.nodeInfoText;
+    this.nodeInfoTextStyle = builder.nodeInfoTextStyle;
+    this.icon = builder.icon;
+    this.userElement = builder.userElement;
+  }
+
+  public String getNodeText() {
+    return nodeText;
+  }
+
+  public StyleConfigurator getNodeTextStyle() {
+    return nodeTextStyle;
+  }
+
+  public String getNodeInfoText() {
+    return nodeInfoText;
+  }
+
+  public StyleConfigurator getNodeInfoTextStyle() {
+    return nodeInfoTextStyle;
+  }
+
+  public SVGResource getIcon() {
+    return icon;
+  }
+
+  public Element getUserElement() {
+    return userElement;
+  }
+
+  public static class Builder {
+    private String nodeText;
+    private StyleConfigurator nodeTextStyle;
+    private String nodeInfoText;
+    private StyleConfigurator nodeInfoTextStyle;
+    private SVGResource icon;
+    private Element userElement;
+
+    public Builder() {}
+
+    public Builder withNodeText(String nodeText) {
+      this.nodeText = nodeText;
+      return this;
+    }
+
+    public Builder withNodeTextStyle(StyleConfigurator nodeTextStyle) {
+      this.nodeTextStyle = nodeTextStyle;
+      return this;
+    }
+
+    public Builder withNodeInfoText(String nodeInfoText) {
+      this.nodeInfoText = nodeInfoText;
+      return this;
+    }
+
+    public Builder withNodeIntoTextStyle(StyleConfigurator nodeInfoTextStyle) {
+      this.nodeInfoTextStyle = nodeInfoTextStyle;
+      return this;
+    }
+
+    public Builder withIcon(SVGResource icon) {
+      this.icon = icon;
+      return this;
+    }
+
+    public Builder withUserElement(Element userElement) {
+      this.userElement = userElement;
+      return this;
+    }
+
+    public NewNodePresentation build() {
+      return new NewNodePresentation(this);
+    }
+  }
+}

ide/che-core-ide-ui/src/main/java/org/eclipse/che/ide/ui/smartTree/presentation/NodePresentation.java

@@ -18,7 +18,9 @@
  * Node presentation.
  *
  * @author Vlad Zhukovskiy
+ * @deprecated use {@link NewNodePresentation} instead
  */
+@Deprecated
 public class NodePresentation {
   private String presentableText;
   private String presentableTextCss;

ide/che-core-ide-ui/src/main/java/org/eclipse/che/ide/ui/smartTree/presentation/StyleConfigurator.java

@@ -0,0 +1,96 @@
+/*
+ * Copyright (c) 2012-2017 Red Hat, Inc.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.ide.ui.smartTree.presentation;
+
+import static com.google.common.base.Strings.isNullOrEmpty;
+import static java.util.Collections.unmodifiableMap;
+
+import com.google.gwt.dom.client.Style.FontStyle;
+import com.google.gwt.dom.client.Style.FontWeight;
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Css style configurator with builder. Consists of basic style configuration and a map with
+ * additional css properties.
+ *
+ * @author Vlad Zhukovskyi
+ * @since 5.19.0
+ */
+public class StyleConfigurator {
+
+  private static final String STYLE_COLOR = "color";
+  private static final String STYLE_FONT_STYLE = "fontStyle";
+  private static final String STYLE_FONT_WEIGHT = "fontWeight";
+
+  private final Map<String, String> cssConfiguration;
+
+  private StyleConfigurator(Builder builder) {
+    cssConfiguration = new HashMap<>();
+
+    if (!isNullOrEmpty(builder.color)) {
+      cssConfiguration.put(STYLE_COLOR, builder.color);
+    }
+
+    if (builder.fontStyle != null) {
+      cssConfiguration.put(STYLE_FONT_STYLE, builder.fontStyle.getCssName());
+    }
+
+    if (builder.fontWeight != null) {
+      cssConfiguration.put(STYLE_FONT_WEIGHT, builder.fontWeight.getCssName());
+    }
+
+    if (builder.properties != null) {
+      cssConfiguration.putAll(builder.properties);
+    }
+  }
+
+  public Map<String, String> getCssConfiguration() {
+    return unmodifiableMap(cssConfiguration);
+  }
+
+  public static class Builder {
+    private String color;
+    private FontStyle fontStyle;
+    private FontWeight fontWeight;
+    private Map<String, String> properties;
+
+    public Builder() {}
+
+    public Builder withColor(String color) {
+      this.color = color;
+      return this;
+    }
+
+    public Builder withFontStyle(FontStyle fontStyle) {
+      this.fontStyle = fontStyle;
+      return this;
+    }
+
+    public Builder withFontWeight(FontWeight fontWeight) {
+      this.fontWeight = fontWeight;
+      return this;
+    }
+
+    public Builder withProperty(String property, String value) {
+      if (properties == null) {
+        properties = new HashMap<>();
+      }
+
+      properties.put(property, value);
+      return this;
+    }
+
+    public StyleConfigurator build() {
+      return new StyleConfigurator(this);
+    }
+  }
+}