Added documentation.

radcortez · radcortez · commit 80b5476de55a · 2014-03-20T11:49:02.000Z
A few layout fixes.
diff --git a/src/main/java/com/cortez/samples/javaee7angular/data/Person.java b/src/main/java/com/cortez/samples/javaee7angular/data/Person.java
@@ -4,6 +4,8 @@
 import javax.persistence.Id;
 
 /**
+ * Simple entity.
+ *
  * @author Roberto Cortez
  */
 @Entity
diff --git a/src/main/java/com/cortez/samples/javaee7angular/pagination/PaginatedListWrapper.java b/src/main/java/com/cortez/samples/javaee7angular/pagination/PaginatedListWrapper.java
@@ -3,6 +3,8 @@
 import java.util.List;
 
 /**
+ * Wraps all the information needed to paginate a table.
+ *
  * @author Roberto Cortez
  */
 public class PaginatedListWrapper<T> {
diff --git a/src/main/java/com/cortez/samples/javaee7angular/rest/PersonResource.java b/src/main/java/com/cortez/samples/javaee7angular/rest/PersonResource.java
@@ -12,6 +12,8 @@
 import java.util.List;
 
 /**
+ * REST Service to expose the data to display in the UI grid.
+ *
  * @author Roberto Cortez
  */
 @Stateless
diff --git a/src/main/webapp/css/style.css b/src/main/webapp/css/style.css
@@ -10,5 +10,5 @@ body {
 
 .gridStyle {
     border: 1px solid rgb(212, 212, 212);
-    height: 180px;
+    height: 185px;
 }
diff --git a/src/main/webapp/script/person.js b/src/main/webapp/script/person.js
@@ -1,6 +1,7 @@
 var app = angular.module('persons', ['ngGrid', 'ui.bootstrap']);
 
 app.controller('personsList', function ($scope, $http) {
+    // Makes the REST request to get the data to populate the grid.
     $scope.refreshGrid = function (page) {
         $http({
             url: 'resources/persons',
@@ -15,22 +16,26 @@ app.controller('personsList', function ($scope, $http) {
         });
     };
 
+    // Do something when the grid is sorted.
+    // The grid throws the ngGridEventSorted that gets picked up here and assigns the sortInfo to the scope.
+    // This will allow to watch the sortInfo in the scope for changed and refresh the grid.
     $scope.$on('ngGridEventSorted', function (event, sortInfo) {
         $scope.sortInfo = sortInfo;
-
     });
 
+    // Watch the sortInfo variable. If changes are detected than we need to refresh the grid.
+    // This also works for the first page access, since we assign the initial sorting in the initialize section.
     $scope.$watch('sortInfo', function () {
         $scope.refreshGrid($scope.persons.currentPage);
     }, true);
 
+    // Initialize required information: sorting, the first page to show and the grid options.
     $scope.sortInfo = {fields: ['id'], directions: ['asc']};
     $scope.persons = {currentPage : 1};
-
     $scope.gridOptions = {
         data: 'persons.list',
         useExternalSorting: true,
-        sortinfo: $scope.sortInfo
+        sortInfo: $scope.sortInfo
     };
 });
 

Original file line number	Diff line number	Diff line change
`@@ -10,5 +10,5 @@ body {`
`10`	`10`
`11`	`11`	`.gridStyle {`
`12`	`12`	`border: 1px solid rgb(212, 212, 212);`
`13`		`- height: 180px;`
	`13`	`+ height: 185px;`
`14`	`14`	`}`