Changeset 4977

Timestamp:

04/15/14 08:16:36 (10 years ago)

Author:

Twan Goosen

Message:

documentation and internal refactoring in expandable panel

Location:

vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/panels

Files:

• ExpandablePanel.java (modified) (5 diffs)
• search/AdvancedSearchOptionsPanel.java (modified) (3 diffs)

vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/panels/ExpandablePanel.java

@@ -26 +26 @@
 import org.apache.wicket.model.AbstractReadOnlyModel;
 import org.apache.wicket.model.IModel;
+import org.apache.wicket.model.Model;
 
 /**
+ * Panel with expand/collapse controls which control the css class of the
+ * component's markup element (as defined in {@link #getExpandedClass() }, {@link #getCollapsedClass()
+ * } and {@link #getFallbackClass() }). It also adds a title that doubles as an
+ * expansion state toggler.
  *
  * @author twagoo
+ * @param <T> the type of the panel's model object
  */
 public abstract class ExpandablePanel<T> extends GenericPanel<T> {
@@ -35 +41 @@
     private final IModel<ExpansionState> expansionModel;
 
+    /**
+     * Creates the panel with its own expansion state model which is closed
+     * initially
+     *
+     * @param id component id
+     * @param model core model of this panel
+     */
+    public ExpandablePanel(String id, IModel<T> model) {
+        this(id, model, Model.of(ExpansionState.COLLAPSED));
+    }
+
+    /**
+     *
+     * @param id component id
+     * @param model core model of this panel
+     * @param expansionStateModel model that holds the expansion state
+     */
     public ExpandablePanel(String id, IModel<T> model, IModel<ExpansionState> expansionStateModel) {
         super(id, model);
         this.expansionModel = expansionStateModel;
 
-        // facet title annex expansion toggler
+        // title annex expansion toggler
         createTitleToggler();
+        // expand/collapse controls
         addExpandCollapse();
 
@@ -54 +78 @@
                 switch (expansionModel.getObject()) {
                     case COLLAPSED:
-                        return "facet collapsedfacet";
+                        return getCollapsedClass();
                     case EXPANDED:
-                        return "facet expandedfacet";
+                        return getExpandedClass();
                     default:
-                        return "facet";
+                        return getFallbackClass();
                 }
             }
@@ -110 +134 @@
         add(titleLink);
     }
-    
+
     protected abstract Label createTitleLabel(String id);
 
@@ -119 +143 @@
     }
 
+    /**
+     *
+     * @return css class for panel if the expansion state is neither collapsed
+     * or expanded
+     */
+    protected String getFallbackClass() {
+        return "facet";
+    }
+
+    /**
+     *
+     * @return css class for panel if the expansion state expanded
+     */
+    protected String getExpandedClass() {
+        return "facet expandedfacet";
+    }
+
+    /**
+     *
+     * @return css class for panel if the expansion state is collapsed
+     */
+    protected String getCollapsedClass() {
+        return "facet collapsedfacet";
+    }
+
 }

vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/panels/search/AdvancedSearchOptionsPanel.java

@@ -18 +18 @@
 
 import eu.clarin.cmdi.vlo.FacetConstants;
-import eu.clarin.cmdi.vlo.pojo.ExpansionState;
 import eu.clarin.cmdi.vlo.pojo.FacetSelection;
 import eu.clarin.cmdi.vlo.pojo.FacetSelectionType;
@@ -31 +30 @@
 import org.apache.wicket.markup.html.form.Form;
 import org.apache.wicket.model.IModel;
-import org.apache.wicket.model.Model;
 
 /**
@@ -45 +43 @@
 
     public AdvancedSearchOptionsPanel(String id, IModel<QueryFacetsSelection> model) {
-        super(id, model, Model.of(ExpansionState.COLLAPSED));
+        super(id, model);
 
         // create a model for the selection state for the FCS facet