Adding support for banner

Author: ahmad-shahid

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

@@ -0,0 +1,40 @@
+package goc.webtemplate;
+
+public class InfoBanner {
+    private String mainHTML;
+    private Link link;
+    private Link button;
+
+    public InfoBanner() {}
+
+    public InfoBanner(String mainHTML, Link link, Link button)
+    {
+        this.mainHTML = mainHTML;
+        this.link = link;
+        this.button = button;
+    }
+
+    public String getMainHTML() {
+        return mainHTML;
+    }
+
+    public void setMainHTML(String mainHTML) {
+        this.mainHTML = mainHTML;
+    }
+
+    public Link getLink() {
+        return link;
+    }
+
+    public void setLink(Link link) {
+        this.link = link;
+    }
+
+    public Link getButton() {
+        return button;
+    }
+
+    public void setButton(Link button) {
+        this.button = button;
+    }
+}

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

@@ -20,6 +20,7 @@
 import goc.webtemplate.FooterLink;
 import goc.webtemplate.FooterSection;
 import goc.webtemplate.IFooterSection;
+import goc.webtemplate.InfoBanner;
 import goc.webtemplate.IntranetTitle;
 import goc.webtemplate.LanguageLink;
 import goc.webtemplate.LeavingSecureSiteWarning;
@@ -152,6 +153,7 @@ private enum Themes { GCWEB, GCINTRANET }
     private boolean gcToolsModal = false;
     private String footerPath = null;
     private boolean hidePlaceholderMenu = false;
+    private InfoBanner infoBanner = null;
     //-------------------------------------------------------
 
     //-------------------------------------------------------
@@ -1473,6 +1475,25 @@ public void setHidePlaceholderMenu(boolean value) {
         this.hidePlaceholderMenu = value;
     }
 
+    /**
+     * Returns whether to display an information banner on top of the page
+     *
+     * can be overriden programatically.
+     */
+    public InfoBanner getInfoBanner() {
+        this.initializeOnce();
+        return this.infoBanner;
+    }
+
+    /**
+     * Sets whether to display an information banner on top of the page
+     *
+     * can be overriden programatically.
+     */
+    public void setInfoBanner(InfoBanner value) {
+        this.infoBanner = value;
+    }
+
     /**
      * Returns a copy of the breadcrumb list, ready for JSON serialization 
      */
@@ -1880,7 +1901,8 @@ public String getRenderAppTop() {
                     this.getEncodedBreadcrumbs(),
                     this.showPreContent,
                     this.customSearch != null? Arrays.asList(this.customSearch): null,
-                    this.getHasLeftMenuSections() //topSecMenu, true if there is at least one left menu section defined
+                    this.getHasLeftMenuSections(), //topSecMenu, true if there is at least one left menu section defined
+                    this.infoBanner
                     );
         } else {
             appTop = new AppTop.AppTopGCIntranet(

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

@@ -8,6 +8,7 @@
 
 import goc.webtemplate.Breadcrumb;
 import goc.webtemplate.CustomSearch;
+import goc.webtemplate.InfoBanner;
 import goc.webtemplate.IntranetTitle;
 import goc.webtemplate.LanguageLink;
 import goc.webtemplate.Link;
@@ -32,6 +33,7 @@ public class AppTop implements Serializable {
     private String              menuPath;
     private List<SecMenuItem>   menuLinks;
     private List<LanguageLink>  lngLinks;
+    private InfoBanner          infoBanner;
 
     /**
      * This is a List but should only have one item in it.
@@ -60,7 +62,7 @@ public AppTop()
 
     public AppTop(String cdnEnv, String subTheme, String localPath, List<Link> appName, String menuPath,
             List<SecMenuItem> menuLinks, List<LanguageLink> lngLinks, List<Link> signIn, List<Link> signOut, List<Link> appSettings,
-            boolean search, List<Breadcrumb> breadcrumbs, boolean showPreContent, List<CustomSearch> customSearch, boolean topSecMenu) {
+            boolean search, List<Breadcrumb> breadcrumbs, boolean showPreContent, List<CustomSearch> customSearch, boolean topSecMenu, InfoBanner infoBanner) {
         this.cdnEnv = cdnEnv;
         this.subTheme = subTheme;
         this.localPath = localPath;
@@ -76,6 +78,7 @@ public AppTop(String cdnEnv, String subTheme, String localPath, List<Link> appNa
         this.showPreContent = showPreContent;
         this.customSearch = customSearch;
         this.topSecMenu = topSecMenu;
+        this.infoBanner = infoBanner;
     }
 
     public String getCdnEnv() {
@@ -197,6 +200,14 @@ public boolean isTopSecMenu() {
     public void setTopSecMenu(boolean topSecMenu) {
         this.topSecMenu = topSecMenu;
     }
+    
+    public InfoBanner getInfoBanner() {
+        return infoBanner;
+    }
+    
+    public void setInfoBanner(InfoBanner infoBanner) {
+        this.infoBanner = infoBanner;
+    }
 
 
     /**
@@ -225,7 +236,7 @@ public AppTopGCIntranet(String cdnEnv, String subTheme, String localPath, List<L
 
             super(cdnEnv, subTheme, localPath, appName, menuPath,
                     menuLinks, lngLinks, signIn, signOut, appSettings,
-                    search, breadcrumbs, showPreContent, customSearch, topSecMenu);
+                    search, breadcrumbs, showPreContent, customSearch, topSecMenu, null);
 
             this.intranetTitle = intranetTitle;
             this.gcToolsModal = gcToolsModal;

gocwebtemplate-core/gocwebtemplate-core-base/src/test/java/goc/webtemplate/component/abstractcorebeantest/RenderAppTopTest.java

@@ -1,11 +1,14 @@
 package goc.webtemplate.component.abstractcorebeantest;
 
+import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import java.util.ArrayList;
 
 import org.junit.jupiter.api.Test;
 
+import goc.webtemplate.InfoBanner;
+import goc.webtemplate.Link;
 import goc.webtemplate.MenuItem;
 
 public class RenderAppTopTest {
@@ -26,4 +29,15 @@ public void testCustomMenuItem() {
         		"RenderTop: Custom MenuItem not rendered as expected.");
     }
 
+    @Test
+    public void testInfoBanner() {
+        AbstractCoreBeanImpl sut = new AbstractCoreBeanImpl();
+
+        InfoBanner banner = new InfoBanner("Main Text", new Link("google", "Link"), new Link("yahoo", "Button"));
+        sut.setInfoBanner(banner);
+
+        assertTrue(sut.getRenderAppTop().contains("\"infoBanner\":{\"mainHTML\":\"Main Text\",\"link\":{\"href\":\"google\",\"text\":\"Link\"},\"button\":{\"href\":\"yahoo\",\"text\":\"Button\"}"),
+        		"\"RenderTop: InfoBanner not rendered as expected.\"");
+    }
+
 }