Merge pull request #17 from wet-boew/13-add-support-for-new-footer

Adding support for new footer

Author: plup2

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ## v2.6.0
 
+- **IMPORTANT** The GCWeb site footer has been updated to reflect the changes introduced in WET footer version 4. These changes will be applied automatically. For more information, please visit the WET documentation: https://wet-boew.github.io/GCWeb/sites/footers/footers-en.html
 - [CDTS](https://github.com/wet-boew/cdts-sgdc/) v4.0.47 & [wet-boew](https://github.com/wet-boew/wet-boew) v4.0.56.5
 - Updated static fallback files
 - Bug Fixes

gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/BannerLink.java

@@ -0,0 +1,33 @@
+package goc.webtemplate;
+
+public class BannerLink extends Link{
+    private static final long serialVersionUID = 1L;
+
+    private boolean newWindow;
+    
+    public BannerLink() {}
+
+    public BannerLink(String href)
+    {
+        this(href, "");
+    }
+
+    public BannerLink(String href, String text)
+    {   
+        this(href, text, false);
+    }
+
+    public BannerLink(String href, String text, boolean newWindow)
+    {   
+        super(href, text);
+        this.newWindow = newWindow;
+    }
+
+    public boolean isNewWindow() {
+        return newWindow;
+    }
+
+    public void setNewWindow(boolean newWindow) {
+        this.newWindow = newWindow;
+    }
+}

gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/ContextualFooter.java

@@ -0,0 +1,33 @@
+package goc.webtemplate;
+
+import java.util.List;
+
+public class ContextualFooter {
+
+    private String title;
+    private List<FooterLink> links;
+
+    public ContextualFooter() {}
+
+    public ContextualFooter(String title, List<FooterLink> links)
+    {
+        this.title = title;
+        this.links = links;
+    }
+
+    public String getTitle() {
+        return title;
+    }
+
+    public void setTitle(String title) {
+        this.title = title;
+    }
+
+    public List<FooterLink> getLinks() {
+        return links;
+    }
+
+    public void setLinks(List<FooterLink> links) {
+        this.links = links;
+    }
+}

gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/InfoBanner.java

@@ -2,12 +2,12 @@
 
 public class InfoBanner {
     private String mainHTML;
-    private Link link;
-    private Link button;
+    private BannerLink link;
+    private BannerLink button;
 
     public InfoBanner() {}
 
-    public InfoBanner(String mainHTML, Link link, Link button)
+    public InfoBanner(String mainHTML, BannerLink link, BannerLink button)
     {
         this.mainHTML = mainHTML;
         this.link = link;
@@ -22,19 +22,19 @@ public void setMainHTML(String mainHTML) {
         this.mainHTML = mainHTML;
     }
 
-    public Link getLink() {
+    public BannerLink getLink() {
         return link;
     }
 
-    public void setLink(Link link) {
+    public void setLink(BannerLink link) {
         this.link = link;
     }
 
-    public Link getButton() {
+    public BannerLink getButton() {
         return button;
     }
 
-    public void setButton(Link button) {
+    public void setButton(BannerLink button) {
         this.button = button;
     }
 }

gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/AbstractCoreBean.java

@@ -16,6 +16,7 @@
 
 import goc.webtemplate.Breadcrumb;
 import goc.webtemplate.Constants;
+import goc.webtemplate.ContextualFooter;
 import goc.webtemplate.CustomSearch;
 import goc.webtemplate.FooterLink;
 import goc.webtemplate.FooterSection;
@@ -32,6 +33,8 @@
 import goc.webtemplate.Utility;
 import goc.webtemplate.WebAnalyticsInfo;
 
+import static goc.webtemplate.component.JsonRenderer.gson;
+
 import goc.webtemplate.component.jsonentities.AppFooter;
 import goc.webtemplate.component.jsonentities.AppTop;
 import goc.webtemplate.component.jsonentities.CDTSEnvironment;
@@ -60,19 +63,6 @@
  *
  */
 public abstract class AbstractCoreBean {
-    /**
-     * Object used for JSON serialization.  (https://github.com/google/gson)
-     * 
-     * According to documentation (http://www.javadoc.io/doc/com.google.code.gson/gson/2.8.0) 
-     * and source code, Gson objects are thread-safe.
-     */
-    //NOTE: Doesn't render null values by default, which is what we want
-    //NOTE: Escapes HTML by default, which is what we want (though URLs still need to be encoded)
-    //NOTE: Indented output can be obtained by chaining a call to setPrettyPrinting()
-    private static Gson gson = new com.google.gson.GsonBuilder()
-                                        .setFieldNamingPolicy(com.google.gson.FieldNamingPolicy.IDENTITY)
-                                        .create();
-
     /**
      * Hold the table of CDTS environment configuration objects (loaded the first time it is accessed).
      */
@@ -154,6 +144,9 @@ private enum Themes { GCWEB, GCINTRANET }
     private String footerPath = null;
     private boolean hidePlaceholderMenu = false;
     private InfoBanner infoBanner = null;
+    private ContextualFooter contextualFooter = null;
+    private boolean hideMainFooter = false;
+    private boolean hideCorporateFooter = false;
     //-------------------------------------------------------
 
     //-------------------------------------------------------
@@ -1494,6 +1487,63 @@ public void setInfoBanner(InfoBanner value) {
         this.infoBanner = value;
     }
 
+    /**
+     * Returns whether to display a contextual footer band that can display up to 3 links
+     *
+     * can be overriden programatically.
+     */
+    public ContextualFooter getContextualFooter() {
+        this.initializeOnce();
+        return this.contextualFooter;
+    }
+
+    /**
+     * Sets whether to display a contextual footer band that can display up to 3 links
+     *
+     * can be overriden programatically.
+     */
+    public void setContextualFooter(ContextualFooter value) {
+        this.contextualFooter = value;
+    }
+
+    /**
+     * Returns whether to hide the main footer
+     *
+     * can be overriden programatically.
+     */
+    public boolean getHideMainFooter() {
+        this.initializeOnce();
+        return this.hideMainFooter;
+    }
+
+    /**
+     * Sets whether to hide the main footer
+     *
+     * can be overriden programatically.
+     */
+    public void setHideMainFooter(boolean value) {
+        this.hideMainFooter = value;
+    }
+
+    /**
+     * Returns whether to hide corporate footer links
+     *
+     * can be overriden programatically.
+     */
+    public boolean getHideCorporateFooter() {
+        this.initializeOnce();
+        return this.hideCorporateFooter;
+    }
+
+    /**
+     * Sets whether to hide corporate footer links
+     *
+     * can be overriden programatically.
+     */
+    public void setHideCorporateFooter(boolean value) {
+        this.hideCorporateFooter = value;
+    }
+
     /**
      * Returns a copy of the breadcrumb list, ready for JSON serialization 
      */
@@ -2010,9 +2060,12 @@ public String getRenderFooter() {
                 true, //showFooter,
                 this.getShowFeatures(),
                 this.buildContactLinks(),
-                null, //privacyLink
-                null, //termsLink
-                JsonValueUtils.getNonEmptyString(this.getLocalPath())
+                JsonValueUtils.getFooterLinkContext(this.getPrivacyLink(), true),
+                JsonValueUtils.getFooterLinkContext(this.getTermsConditionsLink(), true),
+                JsonValueUtils.getNonEmptyString(this.getLocalPath()),
+                this.contextualFooter,
+                this.hideMainFooter,
+                this.hideCorporateFooter
             ));        
     }
 
@@ -2027,9 +2080,12 @@ public String getRenderTransactionalFooter() {
                 false, //showFooter
                 this.getShowFeatures(),
                 this.buildContactLinks(),
-                JsonValueUtils.getNonEmptySingleItemLinkList(this.getPrivacyLink()),
-                JsonValueUtils.getNonEmptySingleItemLinkList(this.getTermsConditionsLink()),
-                JsonValueUtils.getNonEmptyString(this.getLocalPath())
+                JsonValueUtils.getFooterLinkContext(this.getPrivacyLink(), false),
+                JsonValueUtils.getFooterLinkContext(this.getTermsConditionsLink(), false),
+                JsonValueUtils.getNonEmptyString(this.getLocalPath()),
+                null,  //contextualFooter
+                false, //hideMainFooter
+                false  //hideCorporateFooter
             ));        
     }
 

gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/JsonRenderer.java

@@ -0,0 +1,18 @@
+package goc.webtemplate.component;
+
+import com.google.gson.Gson;
+
+public final class JsonRenderer {
+    /**
+     * Object used for JSON serialization.  (https://github.com/google/gson)
+     * 
+     * According to documentation (http://www.javadoc.io/doc/com.google.code.gson/gson/2.8.0) 
+     * and source code, Gson objects are thread-safe.
+     */
+    //NOTE: Doesn't render null values by default, which is what we want
+    //NOTE: Escapes HTML by default, which is what we want (though URLs still need to be encoded)
+    //NOTE: Indented output can be obtained by chaining a call to setPrettyPrinting()
+    public static Gson gson = new com.google.gson.GsonBuilder()
+                                        .setFieldNamingPolicy(com.google.gson.FieldNamingPolicy.IDENTITY)
+                                        .create();
+}

gocwebtemplate-core/gocwebtemplate-core-base/src/main/java/goc/webtemplate/component/JsonValueUtils.java

@@ -8,6 +8,8 @@
 import goc.webtemplate.Link;
 import goc.webtemplate.Utility;
 
+import goc.webtemplate.component.jsonentities.FooterLinkContext;
+
 public final class JsonValueUtils {
 
     /**
@@ -107,4 +109,12 @@ public static boolean getBooleanValue(String value, boolean defaultValue)
     {
         return Utility.isNullOrEmpty(value)? defaultValue: Boolean.parseBoolean(value);
     }
+
+    /**
+     * Returns FooterLinkContext value depending on the value of showFooter
+     * If the link href if null, then a null value is returned
+     */
+    public static FooterLinkContext getFooterLinkContext(FooterLink link, boolean showFooter) {
+        return Utility.isNullOrEmpty(link.getHref())? null: new FooterLinkContext(showFooter, link);
+    }
 }