Added a new property for managing the themed top bar's title (#1524)

windup · Oct 5, 2022 · 3f61baf · 3f61baf
1 parent 4a516da
commit 3f61baf
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 3 deletions.
diff --git a/bootstraps-themed/bootstrap-mta/src/main/resources/windup-config.properties b/bootstraps-themed/bootstrap-mta/src/main/resources/windup-config.properties
@@ -1,6 +1,7 @@
 # We need duplicate this file and have it here as a Workaround for not being able
 # to consume org.jboss.windup.util.* because of java.lang.NoClassDefFoundError in windup-distribution
 # TODO: Fix this issue in https://issues.redhat.com/browse/WINDUP-3283 and then remove this block of code
+distributionTopBarTitle=Migration Toolkit for Applications
 distributionBrandName=Migration Toolkit for Applications by Red Hat (MTA)
 distributionBrandNameAcronym=MTA
 distributionBrandWebsiteUrl=https://developers.redhat.com/products/mta/overview/

diff --git a/bootstraps-themed/bootstrap-mtr/src/main/resources/windup-config.properties b/bootstraps-themed/bootstrap-mtr/src/main/resources/windup-config.properties
@@ -1,6 +1,7 @@
 # We need duplicate this file and have it here as a Workaround for not being able
 # to consume org.jboss.windup.util.* because of java.lang.NoClassDefFoundError in windup-distribution
 # TODO: Fix this issue in https://issues.redhat.com/browse/WINDUP-3283 and then remove this block of code
+distributionTopBarTitle=Migration Toolkit for Runtimes
 distributionBrandName=Migration Toolkit for Runtimes by Red Hat (MTR)
 distributionBrandNameAcronym=MTR
 distributionBrandWebsiteUrl=https://developers.redhat.com/products/mtr/overview/

diff --git a/bootstraps-themed/bootstrap-tackle/src/main/resources/windup-config.properties b/bootstraps-themed/bootstrap-tackle/src/main/resources/windup-config.properties
@@ -1,6 +1,7 @@
 # We need duplicate this file and have it here as a Workaround for not being able
 # to consume org.jboss.windup.util.* because of java.lang.NoClassDefFoundError in windup-distribution
 # TODO: Fix this issue in https://issues.redhat.com/browse/WINDUP-3283 and then remove this block of code
+distributionTopBarTitle=Tackle Analysis
 distributionBrandName=Tackle Analysis
 distributionBrandNameAcronym=TACKLE
 distributionBrandWebsiteUrl=https://github.com/konveyor/tackle2-addon-windup

diff --git a/bootstraps-themed/bootstrap-windup/src/main/resources/windup-config.properties b/bootstraps-themed/bootstrap-windup/src/main/resources/windup-config.properties
@@ -1,6 +1,7 @@
 # We need duplicate this file and have it here as a Workaround for not being able
 # to consume org.jboss.windup.util.* because of java.lang.NoClassDefFoundError in windup-distribution
 # TODO: Fix this issue in https://issues.redhat.com/browse/WINDUP-3283 and then remove this block of code
+distributionTopBarTitle=Windup
 distributionBrandName=Windup
 distributionBrandNameAcronym=WINDUP
 distributionBrandWebsiteUrl=https://windup.github.io/

diff --git a/...g/api/src/main/java/org/jboss/windup/reporting/freemarker/GetWindupTopBarTitleMethod.java b/...g/api/src/main/java/org/jboss/windup/reporting/freemarker/GetWindupTopBarTitleMethod.java
@@ -0,0 +1,19 @@
+package org.jboss.windup.reporting.freemarker;
+
+import java.util.List;
+
+import org.jboss.windup.util.ThemeProvider;
+
+import freemarker.template.TemplateModelException;
+
+public class GetWindupTopBarTitleMethod implements WindupFreeMarkerMethod {
+    @Override
+    public String getDescription() {
+        return "Returns the tool top bar title for the current theme.";
+    }
+
+    @Override
+    public Object exec(List arguments) throws TemplateModelException {
+        return ThemeProvider.getInstance().getTheme().getTopBarTitle();
+    }
+}
diff --git a/reporting/impl/src/main/resources/reports/templates/include/navbar_left_brand.ftl b/reporting/impl/src/main/resources/reports/templates/include/navbar_left_brand.ftl
@@ -1,2 +1,2 @@
-<strong class="wu-navbar-header">${getWindupBrandName()}</strong>
+<strong class="wu-navbar-header">${getWindupTopBarTitle()}</strong>
 <img align="right" class="wu-navbar-header" src="${logoPrefix}resources/img/${getWindupBrandNameAcronym()}/brand-horizontal.png" />
diff --git a/utils/src/main/java/org/jboss/windup/util/Theme.java b/utils/src/main/java/org/jboss/windup/util/Theme.java
@@ -2,6 +2,7 @@
 
 public class Theme {
 
+    private final String topBarTitle;
     private final String brandName;
     private final String brandNameAcronym;
     private final String brandWebsiteUrl;
@@ -10,7 +11,8 @@ public class Theme {
     private final String cliVersion;
     private final String componentsVersion;
 
-    public Theme(String brandName, String brandNameAcronym, String brandWebsiteUrl, String brandDocumentationUrl, String cliName, String cliVersion, String componentsVersion) {
+    public Theme(String topBarTitle, String brandName, String brandNameAcronym, String brandWebsiteUrl, String brandDocumentationUrl, String cliName, String cliVersion, String componentsVersion) {
+        this.topBarTitle = topBarTitle;
         this.brandName = brandName;
         this.brandNameAcronym = brandNameAcronym;
         this.brandWebsiteUrl = brandWebsiteUrl;
@@ -20,6 +22,10 @@ public Theme(String brandName, String brandNameAcronym, String brandWebsiteUrl,
         this.componentsVersion = componentsVersion;
     }
 
+    public String getTopBarTitle() {
+        return topBarTitle;
+    }
+
     public String getBrandName() {
         return brandName;
     }

diff --git a/utils/src/main/java/org/jboss/windup/util/ThemeProvider.java b/utils/src/main/java/org/jboss/windup/util/ThemeProvider.java
@@ -35,6 +35,7 @@ private Theme load(InputStream input) throws IOException {
         Properties prop = new Properties();
         prop.load(input);
 
+        final String topBarTitle = prop.getProperty("distributionTopBarTitle");
         final String brandName = prop.getProperty("distributionBrandName");
         final String nameAcronym = prop.getProperty("distributionBrandNameAcronym");
         final String websiteUrl = prop.getProperty("distributionBrandWebsiteUrl");
@@ -51,7 +52,7 @@ private Theme load(InputStream input) throws IOException {
                 // do nothing because the execution continues with the fallback method below
             }
         }
-        return new Theme(brandName, nameAcronym, websiteUrl, documentationUrl, cliName, cliVersion, getRuntimeAPIVersion());
+        return new Theme(topBarTitle, brandName, nameAcronym, websiteUrl, documentationUrl, cliName, cliVersion, getRuntimeAPIVersion());
     }
 
     public static ThemeProvider getInstance() {