Changeset 2970

Timestamp:

06/01/13 11:24:46 (11 years ago)

Author:

keeloo

Message:

Some more work on theming. Now it is possible to add themes.

Location:

vlo/trunk/vlo_web_app/src/main/java/eu/clarin/cmdi/vlo

Files:

• VloWebApplication.java (modified) (8 diffs)
• pages/BasePage.java (modified) (3 diffs)
• pages/BasePanel.java (added)
• pages/FacetBoxPanel.java (modified) (4 diffs)
• pages/FacetHeaderPanel.java (modified) (2 diffs)
• pages/FacetLinkPanel.java (modified) (2 diffs)
• pages/FacetedSearchPage.java (modified) (2 diffs)
• pages/ShowResultPage.java (modified) (3 diffs)

vlo/trunk/vlo_web_app/src/main/java/eu/clarin/cmdi/vlo/VloWebApplication.java

@@ -5 +5 @@
 import eu.clarin.cmdi.vlo.dao.SearchResultsDao;
 import eu.clarin.cmdi.vlo.pages.BasePage;
-import eu.clarin.cmdi.vlo.pages.FacetBoxPanel;
-import eu.clarin.cmdi.vlo.pages.FacetHeaderPanel;
-import eu.clarin.cmdi.vlo.pages.FacetLinkPanel;
+import eu.clarin.cmdi.vlo.pages.BasePanel;
 import eu.clarin.cmdi.vlo.pages.FacetedSearchPage;
-import eu.clarin.cmdi.vlo.pages.ShowResultPage;
 import java.util.Map;
 import javax.servlet.ServletContext;
@@ -22 +19 @@
 
 /**
- * 
- * {@literal V}irtual {@literal L}anguage {@literal O}bservatory web 
- * application<br><br>
+ * Virtual Language Observatory web application<br><br>
  * 
  * <describe VLO>
@@ -32 +27 @@
  */
 public class VloWebApplication extends WebApplication {
-
-    /**
-     * Remember the theme to be used<br><br>
-     * 
-     * The theme parameter is one in a map of parameters that is associated
-     * with a session rather than with some page or pages.
-     */
-    private String theme = "defaultTheme";
-    
-    /**
-     * Get the name of the theme applied currently<br><br>
-     * 
-     * @return the theme
-     */
-    public String getThemeName (){
-        // maybe this method will not be needed anymore; query 
-        // the session parameters instead
-        return theme;
-    }
-    
-    /**
-     * Set the name of the theme applied or to be applied
-     */
-    public void setThemeName (String theme){
-        // store the name as a session parameter
-        this.theme = theme;
-    }
-    
-    /**
-     * Install a theme
-     * 
-     * @param name the name of the theme to be installed
-     */
-    public void setTheme (String name){
-       // at some point invoke setThemeName (name) 
-       // at some point add the theme to the list of session parameters
-    }
-    
-    /**
-     * Remember a map of session level parameters<br><br>
-     */
-    PageParameters sessionParameters = new PageParameters ("theme", "defaultTheme");
-    
-    public PageParameters getSessionParameters (){
-        
-        return sessionParameters;
-    }
-    
-    /**
-     * Add the parameters persisting with the application object to an a list
-     * of parameters existing outside the object.<br><br>
-     * 
-     * Invoke this method from a component, after generating a list of 
-     * parameters. 
-     * 
-     * @param parameters the existing list of parameters
-     * @return the concatenation of the existing list and the parameters 
-     * persisting with the application object. 
-     */
-    public PageParameters addSessionParameters(PageParameters parameters) {
-
-        // get the theme parameter from the application
-
-        parameters.add("theme", getThemeName());
+    
+    /**
+     * Remember the parameters that should persist in URLs to VLO pages <br><br>
+     */
+    public PageParameters persistentParameters = new PageParameters();
+            
+    /**
+     * Reflect the persistent parameters in the page parameter map<br><br>
+     * 
+     * @param parameters a page parameter map
+     * @return the page parameter map including the current persistent parameters
+     */
+    public PageParameters reflectPersistentParameters(PageParameters parameters) {
+        
+        parameters.putAll(persistentParameters);
+
+        // parameters.add("theme", "defaultTheme");
         return parameters;
     }
@@ -128 +76 @@
             // check if there is a theme parameter        
             String[] object = map.get("theme");
-            
+                        
             if (object == null) {
-                // no theme in the URL, do not change the value of the parameter
+                // no theme choosen, keep the current one
             } else {
-                // try to replace the reference via the indexs
-                if (theme.equals(object[0])){
-                    // keep the theme that was installed on a previous request
+                // check if the users requests a different theme 
+                if (object[0].matches(currentTheme.name)) {
+                    // current theme requested, nothing to do
                 } else {
-                    // theme not installed yet, first: remember it
-                    VloWebApplication.this.setThemeName(object[0]);
-                    // after that: determine the intended css and "install" it
-                    // determine the intended picture and install it
+                    // different theme requested, compose it
+                    currentTheme = new Theme (object[0]);
                 }
             }
@@ -164 +110 @@
         return cycle;
     }
-
-    private SearchResultsDao searchResults;
-    
+    
+    /**
+     * Theme currently applied in the VLO web application
+     */
+    public Theme currentTheme = new Theme ("defaultTheme"); 
+
+    /**
+     * A theme is defined by a CSS file, and two image files
+     */
+    public class Theme {
+
+        public String name, topLeftImage, topRightImage, cssFile;
+
+        /**
+         * Compose a theme<br><br>
+         *
+         * @param name the name of the theme to be composed
+         */
+        public Theme(String themeName) {
+
+            if (themeName.matches("Clarin-d")) {
+                // select the Clarin-d theme's components
+                
+                topLeftImage = "Images/topleftvlo.gif";
+                topRightImage = "Images/toprightvlo.gif";
+                cssFile = "css/main.css";
+                name = "Clarin-d";
+            } else {
+                // select the default theme elements
+                
+                topLeftImage = "Images/topleftvlo.gif";
+                topRightImage = "Images/toprightvlo.gif";
+                cssFile = "css/main.css";
+                name = "defaultTheme";
+            }
+            // remember the theme as a persistent parameter
+            persistentParameters.put("theme", name);
+        }
+    }
+
     /**
      * Flag indicating whether or not the application object lives in a web
@@ -187 +170 @@
              * method, uniform approach might be the most prefarable one.
              */
-            ShowResultPage.setWebApp(this);
-            FacetBoxPanel.setWebApp(this);
-            FacetHeaderPanel.setWebApp(this);
-            FacetLinkPanel.setWebApp(this);
-            FacetedSearchPage.setWebApp(this);
+            BasePage.setWebApp(this);
+            BasePanel.setWebApp(this);
             
             // install theme -> compose theme
@@ -209 +189 @@
         }
 
-        // start the application
-
+        // creata an object referring to the search results
         searchResults = new SearchResultsDao();        
-    }
-
+
+        // hand over control to the application
+    }
+    
+    // remember the search results
+    private SearchResultsDao searchResults;
+    
     /**
      * Web application constructor<br><br>
@@ -245 +229 @@
      * will create an object that will not look for an external configuration
      * file; it will exclusively rely on the packaged configuration. Typically,
-     * the application's tests will send false to the application constructor.<br><br>
+     * the application's tests will send false to the application constructor.
+     * <br><br>
      * 
      * @param inContext If and only if this parameter equals true. later on, the

vlo/trunk/vlo_web_app/src/main/java/eu/clarin/cmdi/vlo/pages/BasePage.java

@@ -11 +11 @@
 import org.apache.wicket.resource.ContextRelativeResource;
 
+/**
+ * Properties common to all VLO web application's page objects
+ * 
+ * @author keeloo
+ */
 public class BasePage extends WebPage implements IHeaderContributor{
     
+    // reference to the web application object
+    static VloWebApplication webApp;
+
+    /**
+     * Make sure every web application object sends this message
+     *
+     * @param vloWebApplication reference to the web application object
+     */
+    public static void setWebApp(VloWebApplication vloWebApplication) {
+        webApp = vloWebApplication;
+    }
+    
+    /**
+     * Install a VLO theme<br><br>
+     * 
+     * A VLO theme is determined by a CSS file and a banner split in a left and
+     * right image. 
+     * 
+     * The left part of the banner serves as a link to the faceted search page,
+     * the 'local' home page. Next to this page there is the page the web
+     * application is launched from. This home page is defined in the VloConfig
+     * file.
+     *   
+     * @param parameters 
+     */
     public BasePage(PageParameters parameters) {
+
         super(parameters);
         
-        // delete all parameters from the map, except theme
-        String theme;
-        theme = parameters.getKey("theme");
-        if (theme == null){
-            theme = "";
-        }
-        parameters = new PageParameters ();
-        parameters.add("theme", theme);
+        // set the applications local home page link to the faceted search page
+        PageParameters homeLinkParameters = new PageParameters ();
         
-        // set the applications (local) homelink to the faceted search page
+        webApp.reflectPersistentParameters(homeLinkParameters);
+                
                 BookmarkablePageLink link = new BookmarkablePageLink("homeLink", 
-                FacetedSearchPage.class, parameters);
+                FacetedSearchPage.class, homeLinkParameters);
         add(link);
-               
+                       
         // refer to the the left part of the vlo banner as a resource
         Resource leftImageRes;
-        leftImageRes = new ContextRelativeResource("Images/topleftvlo.gif");
+        leftImageRes = new ContextRelativeResource(webApp.currentTheme.topLeftImage);
 
         // create the image
@@ -43 +69 @@
         // refer to the right part of the vlo banner as a resource
         Resource rightImageRes;
-        rightImageRes = new ContextRelativeResource("Images/toprightvlo.gif");
+        rightImageRes = new ContextRelativeResource(webApp.currentTheme.topRightImage);
         
         // create the image
@@ -53 +79 @@
     }
 
+    /**
+     * Include the theme's CSS file in the HTML page<br><br>
+     * 
+     * This method is invoked when Wicket renders a VLO page.
+     * 
+     * @param response 
+     */
     @Override
     public void renderHead(IHeaderResponse response) {
                 
-        response.renderCSSReference("css/main.css");
+        response.renderCSSReference(webApp.currentTheme.cssFile);
     }
     

vlo/trunk/vlo_web_app/src/main/java/eu/clarin/cmdi/vlo/pages/FacetBoxPanel.java

@@ -6 +6 @@
 import java.util.List;
 import java.util.Set;
-
 import org.apache.solr.client.solrj.response.FacetField;
 import org.apache.solr.client.solrj.response.FacetField.Count;
@@ -15 +14 @@
 import org.apache.wicket.markup.html.list.ListItem;
 import org.apache.wicket.markup.html.list.ListView;
-import org.apache.wicket.markup.html.panel.Panel;
 import org.apache.wicket.model.IModel;
 import org.apache.wicket.model.Model;
 
-public class FacetBoxPanel extends Panel {
+public class FacetBoxPanel extends BasePanel {
     private static final Set<String> IGNORABLE_VALUES = new HashSet<String>();
     static {
@@ -31 +29 @@
     private FacetModel facetModel;
     private int maxNrOfFacetValues;
-
-    // reference to the web application object
-    static VloWebApplication webApp;
-    
-    /**
-     * Make sure every web application object sends this message
-     * 
-     * @param vloWebApplication reference to the web application object
-     */
-    public static void setWebApp (VloWebApplication vloWebApplication){
-        webApp = vloWebApplication;
-    }
     
     public FacetBoxPanel(String id, IModel<FacetField> model) {
@@ -81 +67 @@
         pageParameters.add(ShowAllFacetValuesPage.FACET_MIN_OCCURS, "1");
 
-        pageParameters = webApp.addSessionParameters(pageParameters);
+        pageParameters = webApp.reflectPersistentParameters(pageParameters);
         
         add(new BookmarkablePageLink("showMore", ShowAllFacetValuesPage.class, pageParameters) {

vlo/trunk/vlo_web_app/src/main/java/eu/clarin/cmdi/vlo/pages/FacetHeaderPanel.java

@@ -5 +5 @@
 import org.apache.wicket.markup.html.basic.Label;
 import org.apache.wicket.markup.html.link.BookmarkablePageLink;
-import org.apache.wicket.markup.html.panel.Panel;
 import org.apache.wicket.model.IModel;
 
-public class FacetHeaderPanel extends Panel {
+public class FacetHeaderPanel extends BasePanel {
 
     private static final long serialVersionUID = 1L;
-    
-    // reference to the web application object
-    static VloWebApplication webApp;
-    
-    /**
-     * Make sure every web application object sends this message
-     * 
-     * @param vloWebApplication reference to the web application object
-     */
-    public static void setWebApp (VloWebApplication vloWebApplication){
-        webApp = vloWebApplication;
-    }
 
     public FacetHeaderPanel(String id, IModel<FacetModel> model, final SearchPageQuery query) {
@@ -30 +17 @@
         PageParameters pageParameters = copy.getPageParameters();
         
-        pageParameters = webApp.addSessionParameters(pageParameters);
+        pageParameters = webApp.reflectPersistentParameters(pageParameters);
         
         add(new BookmarkablePageLink("allLink", FacetedSearchPage.class, pageParameters));

vlo/trunk/vlo_web_app/src/main/java/eu/clarin/cmdi/vlo/pages/FacetLinkPanel.java

@@ -1 +1 @@
 package eu.clarin.cmdi.vlo.pages;
 
-import eu.clarin.cmdi.vlo.VloWebApplication;
 import org.apache.solr.client.solrj.response.FacetField.Count;
 import org.apache.wicket.PageParameters;
-import org.apache.wicket.Session;
 import org.apache.wicket.markup.html.basic.Label;
 import org.apache.wicket.markup.html.link.BookmarkablePageLink;
 import org.apache.wicket.markup.html.link.Link;
-import org.apache.wicket.markup.html.panel.Panel;
 import org.apache.wicket.model.IModel;
 
-public class FacetLinkPanel extends Panel {
+public class FacetLinkPanel extends BasePanel {
 
     private static final long serialVersionUID = 1L;
-    
-    // reference to the web application object
-    static VloWebApplication webApp;
-    
-    /**
-     * Make sure every web application object sends this message
-     * 
-     * @param vloWebApplication reference to the web application object
-     */
-    public static void setWebApp (VloWebApplication vloWebApplication){
-        webApp = vloWebApplication;
-    }
 
     public FacetLinkPanel(String id, IModel<Count> model, final SearchPageQuery query) {
@@ -35 +20 @@
         PageParameters params = q.getPageParameters();
 
-        params = webApp.addSessionParameters(params);
+        params = webApp.reflectPersistentParameters(params);
         
         Link<Count> facetLink = new BookmarkablePageLink("facetLink", FacetedSearchPage.class, params);

vlo/trunk/vlo_web_app/src/main/java/eu/clarin/cmdi/vlo/pages/FacetedSearchPage.java

@@ -38 +38 @@
     private final static AutoCompleteDao autoCompleteDao = new AutoCompleteDao();
     
-    // reference to the web application object
-    static VloWebApplication webApp;
-    
-    /**
-     * Make sure every web application object sends this message
-     * 
-     * @param vloWebApplication reference to the web application object
-     */
-    public static void setWebApp (VloWebApplication vloWebApplication){
-        webApp = vloWebApplication;
-    }
-    
     /**
      * @param parameters Page parameters
@@ -86 +74 @@
             PageParameters pageParameters = query.getPageParameters();
 
-            pageParameters = webApp.addSessionParameters(pageParameters);
+            pageParameters = webApp.reflectPersistentParameters(pageParameters);
             
             setResponsePage(FacetedSearchPage.class, pageParameters);

vlo/trunk/vlo_web_app/src/main/java/eu/clarin/cmdi/vlo/pages/ShowResultPage.java

@@ -86 +86 @@
             newParam.putAll(query.getPageParameters());
             // add the persistent parameters to this map
-            newParam = webApp.addSessionParameters(newParam);
+            newParam = webApp.reflectPersistentParameters(newParam);
             
             BookmarkablePageLink<String> backLink = new BookmarkablePageLink<String>("backLink", FacetedSearchPage.class, newParam);
@@ -406 +406 @@
         add(link);
     }
-    
-    // reference to the web application object
-    static VloWebApplication webApp;
-    
-    /**
-     * Make sure every web application object sends this message
-     * 
-     * @param vloWebApplication reference to the web application object
-     */
-    public static void setWebApp (VloWebApplication vloWebApplication){
-        webApp = vloWebApplication;
-    }
 
     public static BookmarkablePageLink<ShowResultPage> createBookMarkableLink(String linkId, SearchPageQuery query, String docId) {
@@ -423 +411 @@
         pageParameters.put(ShowResultPage.PARAM_DOC_ID, WicketURLEncoder.QUERY_INSTANCE.encode(docId));
         
-        webApp.addSessionParameters(pageParameters);
+        webApp.reflectPersistentParameters(pageParameters);
         
         BookmarkablePageLink<ShowResultPage> docLink = new BookmarkablePageLink<ShowResultPage>(linkId, ShowResultPage.class,