From 67af71ef38078e8a405b2f98f87839672b6004b3 Mon Sep 17 00:00:00 2001 From: Payten Giles Date: Mon, 22 Jun 2015 12:40:43 +1000 Subject: [PATCH 1/4] Add new 'Move (left | right) within Category' to the header menu options to reorder within the category sort order. Only show these menu options when categories are enabled. --- .../GradebookNgApplication.properties | 2 + .../business/GradebookNgBusinessService.java | 45 +++++++++++++++++-- .../gradebookng/tool/pages/GradebookPage.java | 3 +- .../panels/AssignmentColumnHeaderPanel.html | 2 + .../panels/AssignmentColumnHeaderPanel.java | 40 ++++++++++++++++- tool/src/webapp/scripts/gradebook-grades.js | 8 ++++ 6 files changed, 94 insertions(+), 6 deletions(-) diff --git a/tool/src/java/org/sakaiproject/gradebookng/GradebookNgApplication.properties b/tool/src/java/org/sakaiproject/gradebookng/GradebookNgApplication.properties index 12ab1800a75d..6966d34697a9 100644 --- a/tool/src/java/org/sakaiproject/gradebookng/GradebookNgApplication.properties +++ b/tool/src/java/org/sakaiproject/gradebookng/GradebookNgApplication.properties @@ -137,6 +137,8 @@ assignment.option.edit = Edit Item Details assignment.option.viewgradestatistics = View Grade Statistics assignment.option.moveleft = Move Left assignment.option.moveright = Move Right +assignment.option.moveleftwithincategory = Move Left in Category +assignment.option.moverightwithincategory = Move Right in Category assignment.option.hide = Hide Item assignment.option.setungraded = Set Score for Empty Cells diff --git a/tool/src/java/org/sakaiproject/gradebookng/business/GradebookNgBusinessService.java b/tool/src/java/org/sakaiproject/gradebookng/business/GradebookNgBusinessService.java index 7b2237d98528..d54db951320b 100644 --- a/tool/src/java/org/sakaiproject/gradebookng/business/GradebookNgBusinessService.java +++ b/tool/src/java/org/sakaiproject/gradebookng/business/GradebookNgBusinessService.java @@ -596,6 +596,20 @@ public void updateAssignmentOrder(String siteId, long assignmentId, int order) { this.gradebookService.updateAssignmentOrder(gradebook.getUid(), assignmentId, order); } + /** + * Update the categorized order of an assignment. + * + * @param assignmentId the assignment we are reordering + * @param order the new order + * @throws JAXBException + * @throws IdUnusedException + * @throws PermissionException + */ + public void updateCategorizedAssignmentOrder(long assignmentId, int order) throws JAXBException, IdUnusedException, PermissionException { + String siteId = this.getCurrentSiteId(); + updateCategorizedAssignmentOrder(siteId, assignmentId, order); + } + /** * Update the categorized order of an assignment. @@ -634,7 +648,7 @@ public void updateCategorizedAssignmentOrder(String siteId, long assignmentId, i String category = assignmentToMove.getCategoryName(); - Map> orderedAssignments = getCategorizedAssignmentOrder(siteId); + Map> orderedAssignments = getCategorizedAssignmentsOrder(siteId); if (!orderedAssignments.containsKey(category)) { orderedAssignments.put(category, new ArrayList()); @@ -651,9 +665,9 @@ public void updateCategorizedAssignmentOrder(String siteId, long assignmentId, i /** * Get the ordered categorized assignment ids for the current site */ - public Map> getCategorizedAssignmentOrder() { + public Map> getCategorizedAssignmentsOrder() { try { - return getCategorizedAssignmentOrder(getCurrentSiteId()); + return getCategorizedAssignmentsOrder(getCurrentSiteId()); } catch (JAXBException e) { e.printStackTrace(); } catch(IdUnusedException e) { @@ -673,7 +687,7 @@ public Map> getCategorizedAssignmentOrder() { * @throws IdUnusedException * @throws PermissionException */ - private Map> getCategorizedAssignmentOrder(String siteId) throws JAXBException, IdUnusedException, PermissionException { + private Map> getCategorizedAssignmentsOrder(String siteId) throws JAXBException, IdUnusedException, PermissionException { Site site = null; try { site = this.siteService.getSite(siteId); @@ -724,6 +738,29 @@ private Map> getCategorizedAssignmentOrder(String siteId) thr } + /** + * Get the categorized order for an assignment + * + * @param assignmentId the assignment id + * @throws JAXBException + * @throws IdUnusedException + * @throws PermissionException + */ + public int getCategorizedSortOrder(Long assignmentId) throws JAXBException, IdUnusedException, PermissionException { + String siteId = this.getCurrentSiteId(); + Gradebook gradebook = getGradebook(siteId); + + if(gradebook != null) { + Assignment assignment = gradebookService.getAssignment(gradebook.getUid(), assignmentId); + + Map> categorizedOrder = getCategorizedAssignmentsOrder(siteId); + return categorizedOrder.get(assignment.getCategoryName()).indexOf(assignmentId); + } + + return -1; + } + + /** * Set up initial Categorized Assignment Order */ diff --git a/tool/src/java/org/sakaiproject/gradebookng/tool/pages/GradebookPage.java b/tool/src/java/org/sakaiproject/gradebookng/tool/pages/GradebookPage.java index 7e9b7cb1e4c9..b62e3dc8cc6a 100644 --- a/tool/src/java/org/sakaiproject/gradebookng/tool/pages/GradebookPage.java +++ b/tool/src/java/org/sakaiproject/gradebookng/tool/pages/GradebookPage.java @@ -137,7 +137,8 @@ public void onSubmit(AjaxRequestTarget target, Form form) { throw new RestartResponseException(NoDataPage.class); } - final Map> categorizedAssignmentOrder = businessService.getCategorizedAssignmentOrder(); + + final Map> categorizedAssignmentOrder = businessService.getCategorizedAssignmentsOrder(); //this could potentially be a sortable data provider final ListDataProvider studentGradeMatrix = new ListDataProvider(grades); diff --git a/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.html b/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.html index 45e6319ba935..aa384690e04f 100644 --- a/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.html +++ b/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.html @@ -33,7 +33,9 @@
    • +
    • +
    • diff --git a/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.java b/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.java index f2b0acd1a2ab..77b1fced64f3 100644 --- a/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.java +++ b/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.java @@ -2,6 +2,7 @@ import java.text.SimpleDateFormat; import java.util.Date; +import java.lang.Exception; import org.apache.wicket.AttributeModifier; import org.apache.wicket.ajax.AjaxRequestTarget; @@ -181,7 +182,44 @@ public void onClick() { setResponsePage(new GradebookPage()); } }); - + + + add(new Link("moveCategorizedAssignmentLeft", Model.of(assignment.getId())){ + private static final long serialVersionUID = 1L; + @Override + public void onClick() { + Long assignmentId = this.getModelObject(); + + try { + int order = businessService.getCategorizedSortOrder(assignmentId); + businessService.updateCategorizedAssignmentOrder(assignmentId, (order - 1)); + } catch (Exception e) { + e.printStackTrace(); + error("error reordering within category"); + } + + setResponsePage(new GradebookPage()); + } + }); + + + add(new Link("moveCategorizedAssignmentRight", Model.of(assignment.getId())){ + private static final long serialVersionUID = 1L; + @Override + public void onClick() { + Long assignmentId = this.getModelObject(); + + try { + int order = businessService.getCategorizedSortOrder(assignmentId); + businessService.updateCategorizedAssignmentOrder(assignmentId, (order + 1)); + } catch (Exception e) { + e.printStackTrace(); + error("error reordering within category"); + } + + setResponsePage(new GradebookPage()); + } + }); add(new AjaxLink("hideAssignment", Model.of(assignment.getId())){ private static final long serialVersionUID = 1L; diff --git a/tool/src/webapp/scripts/gradebook-grades.js b/tool/src/webapp/scripts/gradebook-grades.js index ab0e5fb81978..1437ea28d453 100644 --- a/tool/src/webapp/scripts/gradebook-grades.js +++ b/tool/src/webapp/scripts/gradebook-grades.js @@ -766,6 +766,10 @@ GradebookSpreadsheet.prototype.enableGroupByCategory = function() { } }); + // toggle move left/right menu options + self.$table.find(".move-assignment-right, .move-assignment-left").hide(); + self.$table.find(".move-categorized-assignment-right, .move-categorized-assignment-left").show(); + self.$table.find("thead").prepend($categoriesRow); self.$spreadsheet.addClass("gb-grouped-by-category"); self.refreshFixedTableHeader(true); @@ -785,6 +789,10 @@ GradebookSpreadsheet.prototype.disableGroupByCategory = function() { model.moveColumnTo(newColIndex); } + // toggle move left/right menu options + self.$table.find(".move-assignment-right, .move-assignment-left").show(); + self.$table.find(".move-categorized-assignment-right, .move-categorized-assignment-left").hide(); + self.$spreadsheet.removeClass("gb-grouped-by-category"); self.refreshFixedTableHeader(true); self.$spreadsheet.trigger("scroll"); // force redraw of the fixed columns From 2d4f1afef537a4d173b217dbcadafd2ba12b8b4f Mon Sep 17 00:00:00 2001 From: Payten Giles Date: Mon, 22 Jun 2015 14:06:00 +1000 Subject: [PATCH 2/4] Introduce GbSpreadsheetState model to hold the categories enabled state and pass through from the page's toolbar to the header (used by the move left/right actions to determine if categories should be taken into account). As categoriesEnabled is now on the page state, upon refresh the javascript will now reinstate the categories if they were enabled --- .../GradebookNgApplication.properties | 2 - .../tool/model/GbSpreadsheetState.java | 17 +++++ .../gradebookng/tool/pages/GradebookPage.html | 2 +- .../gradebookng/tool/pages/GradebookPage.java | 31 +++++++- .../panels/AssignmentColumnHeaderPanel.html | 2 - .../panels/AssignmentColumnHeaderPanel.java | 76 ++++++++----------- tool/src/webapp/scripts/gradebook-grades.js | 58 ++++++++------ 7 files changed, 112 insertions(+), 76 deletions(-) create mode 100644 tool/src/java/org/sakaiproject/gradebookng/tool/model/GbSpreadsheetState.java diff --git a/tool/src/java/org/sakaiproject/gradebookng/GradebookNgApplication.properties b/tool/src/java/org/sakaiproject/gradebookng/GradebookNgApplication.properties index 6966d34697a9..12ab1800a75d 100644 --- a/tool/src/java/org/sakaiproject/gradebookng/GradebookNgApplication.properties +++ b/tool/src/java/org/sakaiproject/gradebookng/GradebookNgApplication.properties @@ -137,8 +137,6 @@ assignment.option.edit = Edit Item Details assignment.option.viewgradestatistics = View Grade Statistics assignment.option.moveleft = Move Left assignment.option.moveright = Move Right -assignment.option.moveleftwithincategory = Move Left in Category -assignment.option.moverightwithincategory = Move Right in Category assignment.option.hide = Hide Item assignment.option.setungraded = Set Score for Empty Cells diff --git a/tool/src/java/org/sakaiproject/gradebookng/tool/model/GbSpreadsheetState.java b/tool/src/java/org/sakaiproject/gradebookng/tool/model/GbSpreadsheetState.java new file mode 100644 index 000000000000..6208a68c3c3c --- /dev/null +++ b/tool/src/java/org/sakaiproject/gradebookng/tool/model/GbSpreadsheetState.java @@ -0,0 +1,17 @@ +package org.sakaiproject.gradebookng.tool.model; + +import java.io.Serializable; +import lombok.Getter; +import lombok.Setter; + +public class GbSpreadsheetState implements Serializable { + + private static final long serialVersionUID = 1L; + + @Getter @Setter + private boolean categoriesEnabled; + + public GbSpreadsheetState() { + this.categoriesEnabled = false; + } +} diff --git a/tool/src/java/org/sakaiproject/gradebookng/tool/pages/GradebookPage.html b/tool/src/java/org/sakaiproject/gradebookng/tool/pages/GradebookPage.html index 2f5e8d322f25..7f3c618720c3 100644 --- a/tool/src/java/org/sakaiproject/gradebookng/tool/pages/GradebookPage.html +++ b/tool/src/java/org/sakaiproject/gradebookng/tool/pages/GradebookPage.html @@ -43,7 +43,7 @@
  • - +
diff --git a/tool/src/java/org/sakaiproject/gradebookng/tool/pages/GradebookPage.java b/tool/src/java/org/sakaiproject/gradebookng/tool/pages/GradebookPage.java index b62e3dc8cc6a..d84c9d3caeea 100644 --- a/tool/src/java/org/sakaiproject/gradebookng/tool/pages/GradebookPage.java +++ b/tool/src/java/org/sakaiproject/gradebookng/tool/pages/GradebookPage.java @@ -37,6 +37,7 @@ import org.sakaiproject.gradebookng.business.model.GbStudentGradeInfo; import org.sakaiproject.gradebookng.business.util.Temp; import org.sakaiproject.gradebookng.tool.model.GradebookUiSettings; +import org.sakaiproject.gradebookng.tool.model.GbSpreadsheetState; import org.sakaiproject.gradebookng.tool.panels.AddGradeItemPanel; import org.sakaiproject.gradebookng.tool.panels.AssignmentColumnHeaderPanel; import org.sakaiproject.gradebookng.tool.panels.GradeItemCellPanel; @@ -62,6 +63,7 @@ public class GradebookPage extends BasePage { ModalWindow gradeCommentWindow; Form form; + GbSpreadsheetState state; @SuppressWarnings({ "rawtypes", "unchecked", "serial" }) public GradebookPage() { @@ -70,7 +72,9 @@ public GradebookPage() { StopWatch stopwatch = new StopWatch(); stopwatch.start(); Temp.time("GradebookPage init", stopwatch.getTime()); - + + state = new GbSpreadsheetState(); + form = new Form("form"); add(form); @@ -203,7 +207,7 @@ public String getCssClass() { @Override public Component getHeader(String componentId) { - AssignmentColumnHeaderPanel panel = new AssignmentColumnHeaderPanel(componentId, new Model(assignment)); + AssignmentColumnHeaderPanel panel = new AssignmentColumnHeaderPanel(componentId, new Model(assignment), new Model(state)); String category = assignment.getCategoryName(); int order = -1; if (categorizedAssignmentOrder.containsKey(category)) { @@ -260,6 +264,29 @@ public void populateItem(Item cellItem, String componentId, IModel rowModel) { gradeItemSummary.setEscapeModelStrings(false); form.add(gradeItemSummary); + AjaxButton toggleCategoriesToolbarItem = new AjaxButton("toggleCategoriesToolbarItem") { + @Override + protected void onInitialize() { + super.onInitialize(); + if (state.isCategoriesEnabled()) { + add(new AttributeModifier("class", "on")); + } + } + @Override + protected void onSubmit(AjaxRequestTarget target, Form form) { + state.setCategoriesEnabled(!state.isCategoriesEnabled()); + + if (state.isCategoriesEnabled()) { + add(new AttributeModifier("class", "on")); + } else { + add(new AttributeModifier("class", "")); + } + target.add(this); + target.appendJavaScript("sakai.gradebookng.spreadsheet.toggleCategories();"); + } + }; + form.add(toggleCategoriesToolbarItem); + //section and group dropdown final List groups = this.businessService.getSiteSectionsAndGroups(); diff --git a/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.html b/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.html index aa384690e04f..45e6319ba935 100644 --- a/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.html +++ b/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.html @@ -33,9 +33,7 @@
    • -
    • -
    • diff --git a/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.java b/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.java index 77b1fced64f3..00c3d32480b3 100644 --- a/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.java +++ b/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.java @@ -19,6 +19,7 @@ import org.sakaiproject.gradebookng.business.SortDirection; import org.sakaiproject.gradebookng.business.model.GbAssignmentGradeSortOrder; import org.sakaiproject.gradebookng.tool.model.GradebookUiSettings; +import org.sakaiproject.gradebookng.tool.model.GbSpreadsheetState; import org.sakaiproject.gradebookng.tool.pages.EditGradebookItemPage; import org.sakaiproject.gradebookng.tool.pages.GradebookPage; import org.sakaiproject.service.gradebook.shared.Assignment; @@ -35,13 +36,16 @@ public class AssignmentColumnHeaderPanel extends Panel { private static final long serialVersionUID = 1L; private IModel modelData; + private IModel state; @SpringBean(name="org.sakaiproject.gradebookng.business.GradebookNgBusinessService") private GradebookNgBusinessService businessService; - public AssignmentColumnHeaderPanel(String id, IModel modelData) { + public AssignmentColumnHeaderPanel(String id, IModel modelData, IModel state) { super(id); this.modelData = modelData; + this.state = state; + } @Override @@ -160,9 +164,19 @@ public void onClick() { //so we just make sure we get it fresh long assignmentId = this.getModelObject(); - - int order = businessService.getAssignmentSortOrder(assignmentId); - businessService.updateAssignmentOrder(assignmentId, (order-1)); + + if (state.getObject().isCategoriesEnabled()) { + try { + int order = businessService.getCategorizedSortOrder(assignmentId); + businessService.updateCategorizedAssignmentOrder(assignmentId, (order - 1)); + } catch (Exception e) { + e.printStackTrace(); + error("error reordering within category"); + } + } else { + int order = businessService.getAssignmentSortOrder(assignmentId); + businessService.updateAssignmentOrder(assignmentId, (order-1)); + } setResponsePage(new GradebookPage()); } @@ -175,52 +189,26 @@ public void onClick() { public void onClick() { long assignmentId = this.getModelObject(); - - int order = businessService.getAssignmentSortOrder(assignmentId); - businessService.updateAssignmentOrder(assignmentId, (order+1)); - - setResponsePage(new GradebookPage()); - } - }); - - - add(new Link("moveCategorizedAssignmentLeft", Model.of(assignment.getId())){ - private static final long serialVersionUID = 1L; - @Override - public void onClick() { - Long assignmentId = this.getModelObject(); - try { - int order = businessService.getCategorizedSortOrder(assignmentId); - businessService.updateCategorizedAssignmentOrder(assignmentId, (order - 1)); - } catch (Exception e) { - e.printStackTrace(); - error("error reordering within category"); - } - - setResponsePage(new GradebookPage()); - } - }); - - - add(new Link("moveCategorizedAssignmentRight", Model.of(assignment.getId())){ - private static final long serialVersionUID = 1L; - @Override - public void onClick() { - Long assignmentId = this.getModelObject(); - - try { - int order = businessService.getCategorizedSortOrder(assignmentId); - businessService.updateCategorizedAssignmentOrder(assignmentId, (order + 1)); - } catch (Exception e) { - e.printStackTrace(); - error("error reordering within category"); + if (state.getObject().isCategoriesEnabled()) { + try { + int order = businessService.getCategorizedSortOrder(assignmentId); + businessService.updateCategorizedAssignmentOrder(assignmentId, (order + 1)); + } catch (Exception e) { + e.printStackTrace(); + error("error reordering within category"); + } + } else { + int order = businessService.getAssignmentSortOrder(assignmentId); + businessService.updateAssignmentOrder(assignmentId, (order+1)); } - + + setResponsePage(new GradebookPage()); } }); + add(new AjaxLink("hideAssignment", Model.of(assignment.getId())){ private static final long serialVersionUID = 1L; @Override diff --git a/tool/src/webapp/scripts/gradebook-grades.js b/tool/src/webapp/scripts/gradebook-grades.js index 1437ea28d453..e62e019297aa 100644 --- a/tool/src/webapp/scripts/gradebook-grades.js +++ b/tool/src/webapp/scripts/gradebook-grades.js @@ -35,8 +35,7 @@ function GradebookSpreadsheet($spreadsheet) { this.setupColoredCategories(); this.setupPopovers(); - // mark the $spreadsheet as initialized - this.$spreadsheet.addClass("initialized") + this.ready(); }; @@ -693,6 +692,11 @@ GradebookSpreadsheet.prototype.setupToolbar = function() { }; +GradebookSpreadsheet.prototype.toggleCategories = function() { + this.toolbarModel.toggleCategories(); +}; + + GradebookSpreadsheet.prototype._cloneCell = function($cell) { // clone and sanitize the $cell so it can be used in a fixed header/column // and not interfere with javascript bindings already out there @@ -766,10 +770,6 @@ GradebookSpreadsheet.prototype.enableGroupByCategory = function() { } }); - // toggle move left/right menu options - self.$table.find(".move-assignment-right, .move-assignment-left").hide(); - self.$table.find(".move-categorized-assignment-right, .move-categorized-assignment-left").show(); - self.$table.find("thead").prepend($categoriesRow); self.$spreadsheet.addClass("gb-grouped-by-category"); self.refreshFixedTableHeader(true); @@ -789,10 +789,6 @@ GradebookSpreadsheet.prototype.disableGroupByCategory = function() { model.moveColumnTo(newColIndex); } - // toggle move left/right menu options - self.$table.find(".move-assignment-right, .move-assignment-left").show(); - self.$table.find(".move-categorized-assignment-right, .move-categorized-assignment-left").hide(); - self.$spreadsheet.removeClass("gb-grouped-by-category"); self.refreshFixedTableHeader(true); self.$spreadsheet.trigger("scroll"); // force redraw of the fixed columns @@ -1037,6 +1033,21 @@ GradebookSpreadsheet.prototype.setupPopovers = function() { this.$spreadsheet.find('[data-toggle="popover"]').popover(); }; + +GradebookSpreadsheet.prototype.ready = function() { + this.$spreadsheet.addClass("initialized").trigger("ready.gradebookng"); +} + + +GradebookSpreadsheet.prototype.onReady = function(callback) { + if (this.$spreadsheet.is(".initialized")) { + callback(); + } else { + this.$spreadsheet.on("ready.gradebookng", callback); + } +}; + + /************************************************************************************* * AbstractCell - behaviour inherited by all cells */ @@ -1686,23 +1697,20 @@ GradebookToolbar.prototype.setupToggleGradeItems = function() { }; +GradebookToolbar.prototype.toggleCategories = function() { + if ($("#toggleCategoriesToolbarItem").hasClass("on")) { + this.gradebookSpreadsheet.enableGroupByCategory(); + } else { + this.gradebookSpreadsheet.disableGroupByCategory(); + } +}; + GradebookToolbar.prototype.setupToggleCategories = function() { var self = this; - - self.$toolbar.on("click", "#toggleCategoriesToolbarItem", function(event) { - event.preventDefault(); - - $(this).toggleClass("on"); - - if ($(this).hasClass("on")) { - self.gradebookSpreadsheet.enableGroupByCategory(); - } else { - self.gradebookSpreadsheet.disableGroupByCategory(); - } - - return false; - }) -} + self.gradebookSpreadsheet.onReady(function() { + self.toggleCategories(); + }); +}; /************************************************************************************** From a9ae2bd172389971dad48741ac4880791e721776 Mon Sep 17 00:00:00 2001 From: Payten Giles Date: Tue, 23 Jun 2015 09:45:11 +1000 Subject: [PATCH 3/4] Move categoriesEnabled state to the new GradebookUiSettings session model --- .../tool/model/GbSpreadsheetState.java | 17 ------------ .../tool/model/GradebookUiSettings.java | 6 +++++ .../gradebookng/tool/pages/GradebookPage.java | 18 +++++++------ .../panels/AssignmentColumnHeaderPanel.java | 27 ++++++++++++++----- 4 files changed, 36 insertions(+), 32 deletions(-) delete mode 100644 tool/src/java/org/sakaiproject/gradebookng/tool/model/GbSpreadsheetState.java diff --git a/tool/src/java/org/sakaiproject/gradebookng/tool/model/GbSpreadsheetState.java b/tool/src/java/org/sakaiproject/gradebookng/tool/model/GbSpreadsheetState.java deleted file mode 100644 index 6208a68c3c3c..000000000000 --- a/tool/src/java/org/sakaiproject/gradebookng/tool/model/GbSpreadsheetState.java +++ /dev/null @@ -1,17 +0,0 @@ -package org.sakaiproject.gradebookng.tool.model; - -import java.io.Serializable; -import lombok.Getter; -import lombok.Setter; - -public class GbSpreadsheetState implements Serializable { - - private static final long serialVersionUID = 1L; - - @Getter @Setter - private boolean categoriesEnabled; - - public GbSpreadsheetState() { - this.categoriesEnabled = false; - } -} diff --git a/tool/src/java/org/sakaiproject/gradebookng/tool/model/GradebookUiSettings.java b/tool/src/java/org/sakaiproject/gradebookng/tool/model/GradebookUiSettings.java index 30b4443c4e47..0cc2c1684295 100644 --- a/tool/src/java/org/sakaiproject/gradebookng/tool/model/GradebookUiSettings.java +++ b/tool/src/java/org/sakaiproject/gradebookng/tool/model/GradebookUiSettings.java @@ -17,6 +17,10 @@ public class GradebookUiSettings implements Serializable { private static final long serialVersionUID = 1L; + public GradebookUiSettings() { + this.categoriesEnabled = false; + } + @Getter @Setter private String groupFilter; @@ -26,4 +30,6 @@ public class GradebookUiSettings implements Serializable { @Getter @Setter private GbAssignmentGradeSortOrder assignmentSortOrder; + @Getter @Setter + private boolean categoriesEnabled; } diff --git a/tool/src/java/org/sakaiproject/gradebookng/tool/pages/GradebookPage.java b/tool/src/java/org/sakaiproject/gradebookng/tool/pages/GradebookPage.java index d84c9d3caeea..e47c8084feeb 100644 --- a/tool/src/java/org/sakaiproject/gradebookng/tool/pages/GradebookPage.java +++ b/tool/src/java/org/sakaiproject/gradebookng/tool/pages/GradebookPage.java @@ -37,7 +37,6 @@ import org.sakaiproject.gradebookng.business.model.GbStudentGradeInfo; import org.sakaiproject.gradebookng.business.util.Temp; import org.sakaiproject.gradebookng.tool.model.GradebookUiSettings; -import org.sakaiproject.gradebookng.tool.model.GbSpreadsheetState; import org.sakaiproject.gradebookng.tool.panels.AddGradeItemPanel; import org.sakaiproject.gradebookng.tool.panels.AssignmentColumnHeaderPanel; import org.sakaiproject.gradebookng.tool.panels.GradeItemCellPanel; @@ -63,7 +62,6 @@ public class GradebookPage extends BasePage { ModalWindow gradeCommentWindow; Form form; - GbSpreadsheetState state; @SuppressWarnings({ "rawtypes", "unchecked", "serial" }) public GradebookPage() { @@ -73,8 +71,6 @@ public GradebookPage() { stopwatch.start(); Temp.time("GradebookPage init", stopwatch.getTime()); - state = new GbSpreadsheetState(); - form = new Form("form"); add(form); @@ -207,7 +203,7 @@ public String getCssClass() { @Override public Component getHeader(String componentId) { - AssignmentColumnHeaderPanel panel = new AssignmentColumnHeaderPanel(componentId, new Model(assignment), new Model(state)); + AssignmentColumnHeaderPanel panel = new AssignmentColumnHeaderPanel(componentId, new Model(assignment)); String category = assignment.getCategoryName(); int order = -1; if (categorizedAssignmentOrder.containsKey(category)) { @@ -268,15 +264,21 @@ public void populateItem(Item cellItem, String componentId, IModel rowModel) { @Override protected void onInitialize() { super.onInitialize(); - if (state.isCategoriesEnabled()) { + GradebookUiSettings settings = getUiSettings(); + if (settings != null && settings.isCategoriesEnabled()) { add(new AttributeModifier("class", "on")); } } @Override protected void onSubmit(AjaxRequestTarget target, Form form) { - state.setCategoriesEnabled(!state.isCategoriesEnabled()); + GradebookUiSettings settings = getUiSettings(); + if (settings == null) { + settings = new GradebookUiSettings(); + } + settings.setCategoriesEnabled(!settings.isCategoriesEnabled()); + setUiSettings(settings); - if (state.isCategoriesEnabled()) { + if (settings.isCategoriesEnabled()) { add(new AttributeModifier("class", "on")); } else { add(new AttributeModifier("class", "")); diff --git a/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.java b/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.java index 00c3d32480b3..4463fcae756b 100644 --- a/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.java +++ b/tool/src/java/org/sakaiproject/gradebookng/tool/panels/AssignmentColumnHeaderPanel.java @@ -19,7 +19,6 @@ import org.sakaiproject.gradebookng.business.SortDirection; import org.sakaiproject.gradebookng.business.model.GbAssignmentGradeSortOrder; import org.sakaiproject.gradebookng.tool.model.GradebookUiSettings; -import org.sakaiproject.gradebookng.tool.model.GbSpreadsheetState; import org.sakaiproject.gradebookng.tool.pages.EditGradebookItemPage; import org.sakaiproject.gradebookng.tool.pages.GradebookPage; import org.sakaiproject.service.gradebook.shared.Assignment; @@ -36,15 +35,13 @@ public class AssignmentColumnHeaderPanel extends Panel { private static final long serialVersionUID = 1L; private IModel modelData; - private IModel state; @SpringBean(name="org.sakaiproject.gradebookng.business.GradebookNgBusinessService") private GradebookNgBusinessService businessService; - public AssignmentColumnHeaderPanel(String id, IModel modelData, IModel state) { + public AssignmentColumnHeaderPanel(String id, IModel modelData) { super(id); this.modelData = modelData; - this.state = state; } @@ -89,7 +86,7 @@ public void onClick() { //set the class based on the sortOrder. May not be set for this assignment GradebookPage gradebookPage = (GradebookPage) this.getPage(); GradebookUiSettings settings = gradebookPage.getUiSettings(); - if(settings != null) { + if(settings != null && settings.getAssignmentSortOrder() != null) { title.add(new AttributeModifier("class", "gb-sort-" + settings.getAssignmentSortOrder().getDirection().toString().toLowerCase())); } @@ -165,7 +162,15 @@ public void onClick() { long assignmentId = this.getModelObject(); - if (state.getObject().isCategoriesEnabled()) { + GradebookPage gradebookPage = (GradebookPage) this.getPage(); + GradebookUiSettings settings = gradebookPage.getUiSettings(); + + if (settings == null) { + settings = new GradebookUiSettings(); + gradebookPage.setUiSettings(settings); + } + + if (settings.isCategoriesEnabled()) { try { int order = businessService.getCategorizedSortOrder(assignmentId); businessService.updateCategorizedAssignmentOrder(assignmentId, (order - 1)); @@ -190,7 +195,15 @@ public void onClick() { long assignmentId = this.getModelObject(); - if (state.getObject().isCategoriesEnabled()) { + GradebookPage gradebookPage = (GradebookPage) this.getPage(); + GradebookUiSettings settings = gradebookPage.getUiSettings(); + + if (settings == null) { + settings = new GradebookUiSettings(); + gradebookPage.setUiSettings(settings); + } + + if (settings.isCategoriesEnabled()) { try { int order = businessService.getCategorizedSortOrder(assignmentId); businessService.updateCategorizedAssignmentOrder(assignmentId, (order + 1)); From 1695ceb4f9e4ef2834b9860a51712f8900a14bd3 Mon Sep 17 00:00:00 2001 From: Payten Giles Date: Tue, 23 Jun 2015 16:07:19 +1000 Subject: [PATCH 4/4] Persist the grade item column visibility in the GradebookUiSettings session state and change the Javascript to reinstate any hidden columns upon page ready --- .../tool/model/GradebookUiSettings.java | 18 +++++++++ .../panels/ToggleGradeItemsToolbarPanel.java | 37 ++++++++++++++++--- tool/src/webapp/scripts/gradebook-grades.js | 5 +++ 3 files changed, 55 insertions(+), 5 deletions(-) diff --git a/tool/src/java/org/sakaiproject/gradebookng/tool/model/GradebookUiSettings.java b/tool/src/java/org/sakaiproject/gradebookng/tool/model/GradebookUiSettings.java index 0cc2c1684295..633bc1f3635e 100644 --- a/tool/src/java/org/sakaiproject/gradebookng/tool/model/GradebookUiSettings.java +++ b/tool/src/java/org/sakaiproject/gradebookng/tool/model/GradebookUiSettings.java @@ -1,6 +1,8 @@ package org.sakaiproject.gradebookng.tool.model; import java.io.Serializable; +import java.util.Map; +import java.util.HashMap; import lombok.Getter; import lombok.Setter; @@ -19,8 +21,10 @@ public class GradebookUiSettings implements Serializable { public GradebookUiSettings() { this.categoriesEnabled = false; + assignmentVisibility = new HashMap(); } + @Getter @Setter private String groupFilter; @@ -32,4 +36,18 @@ public GradebookUiSettings() { @Getter @Setter private boolean categoriesEnabled; + + private Map assignmentVisibility; + + public boolean isAssignmentVisible(Long assignmentId) { + if (assignmentVisibility.containsKey(assignmentId)) { + return assignmentVisibility.get(assignmentId); + } + + return true; + } + + public void setAssignmentVisibility(Long assignmentId, Boolean visible) { + assignmentVisibility.put(assignmentId, visible); + } } diff --git a/tool/src/java/org/sakaiproject/gradebookng/tool/panels/ToggleGradeItemsToolbarPanel.java b/tool/src/java/org/sakaiproject/gradebookng/tool/panels/ToggleGradeItemsToolbarPanel.java index 6711d885e76e..4c367655be78 100644 --- a/tool/src/java/org/sakaiproject/gradebookng/tool/panels/ToggleGradeItemsToolbarPanel.java +++ b/tool/src/java/org/sakaiproject/gradebookng/tool/panels/ToggleGradeItemsToolbarPanel.java @@ -1,6 +1,8 @@ package org.sakaiproject.gradebookng.tool.panels; import org.apache.wicket.AttributeModifier; +import org.apache.wicket.ajax.AjaxRequestTarget; +import org.apache.wicket.ajax.markup.html.form.AjaxCheckBox; import org.apache.wicket.markup.html.basic.Label; import org.apache.wicket.markup.html.form.CheckBox; import org.apache.wicket.markup.html.list.ListItem; @@ -9,9 +11,12 @@ import org.apache.wicket.markup.repeater.Item; import org.apache.wicket.markup.repeater.RepeatingView; import org.apache.wicket.markup.repeater.data.ListDataProvider; +import org.apache.wicket.model.Model; import org.apache.wicket.model.PropertyModel; import org.apache.xmlbeans.impl.piccolo.xml.Piccolo; import org.sakaiproject.gradebookng.business.model.GbGradeInfo; +import org.sakaiproject.gradebookng.tool.model.GradebookUiSettings; +import org.sakaiproject.gradebookng.tool.pages.GradebookPage; import org.sakaiproject.service.gradebook.shared.Assignment; import java.util.Collections; @@ -53,8 +58,11 @@ public ToggleGradeItemsToolbarPanel(String id, final List assignment @Override protected void populateItem(ListItem categoryItem) { String category = categoryItem.getModelObject(); - + + final GradebookPage gradebookPage = (GradebookPage) this.getPage(); + categoryItem.add(new Label("category", category)); + CheckBox categoryCheckbox = new CheckBox("categoryCheckbox"); categoryCheckbox.add(new AttributeModifier("value", category)); categoryCheckbox.add(new AttributeModifier("checked", "checked")); @@ -65,13 +73,32 @@ protected void populateItem(ListItem categoryItem) { @Override protected void populateItem(ListItem assignmentItem) { - Assignment assignment = assignmentItem.getModelObject(); - + final Assignment assignment = assignmentItem.getModelObject(); + + GradebookUiSettings settings = gradebookPage.getUiSettings(); + if (settings == null) { + settings = new GradebookUiSettings(); + gradebookPage.setUiSettings(settings); + } + assignmentItem.add(new Label("assignmentTitle", assignment.getName())); - CheckBox assignmentCheckbox = new CheckBox("assignmentCheckbox"); + + CheckBox assignmentCheckbox = new AjaxCheckBox("assignmentCheckbox", Model.of(Boolean.valueOf(settings.isAssignmentVisible(assignment.getId())))) { + @Override + protected void onUpdate(AjaxRequestTarget target) { + GradebookUiSettings settings = gradebookPage.getUiSettings(); + if (settings == null) { + settings = new GradebookUiSettings(); + } + + Boolean value = getModelObject(); + settings.setAssignmentVisibility(assignment.getId(), value); + + gradebookPage.setUiSettings(settings); + } + }; assignmentCheckbox.add(new AttributeModifier("value", assignment.getId().toString())); assignmentCheckbox.add(new AttributeModifier("data-colidx", assignments.indexOf(assignment))); - assignmentCheckbox.add(new AttributeModifier("checked", "checked")); assignmentItem.add(assignmentCheckbox); } }); diff --git a/tool/src/webapp/scripts/gradebook-grades.js b/tool/src/webapp/scripts/gradebook-grades.js index e62e019297aa..4451df3b734d 100644 --- a/tool/src/webapp/scripts/gradebook-grades.js +++ b/tool/src/webapp/scripts/gradebook-grades.js @@ -1694,6 +1694,11 @@ GradebookToolbar.prototype.setupToggleGradeItems = function() { self.$gradeItemsFilterPanel.find(".gradebook-item-category-filter :input").on("change", handleCategoryFilterStateChange); self.$gradeItemsFilterPanel.find(".gradebook-item-filter :input").on("change", handleGradeItemFilterStateChange); + + // Reinstate hidden columns + self.gradebookSpreadsheet.onReady(function() { + self.$gradeItemsFilterPanel.find(":input:not(:checked)").trigger("change"); + }); };