Merge pull request #146 from KasperHeyndrickx/JENKINS-64376

[JENKINS-64376] Add hidden columns

Author: uhafner

src/main/java/io/jenkins/plugins/datatables/TableColumn.java

@@ -166,7 +166,9 @@ public enum ColumnCss {
          */
         NUMBER("text-right"),
         /** Disables sorting of the column. Rendering is the same as with {@code NONE}. */
-        NO_SORT("nosort");
+        NO_SORT("nosort"),
+        /** Hides the column for view. It still exists and responds to searching */
+        HIDDEN("hidden");
 
         private final String cssClass;
 

src/main/resources/data-tables/table.jelly

@@ -35,7 +35,8 @@
     </j:if>
     <table class="table table-hover table-striped data-table ${class}"
            data-columns-definition="${model.columnsDefinition}" id="${model.id}"
-           data-table-configuration="${model.tableConfigurationDefinition}">
+           data-table-configuration="${model.tableConfigurationDefinition}"
+           style="width: 100%;">
       <colgroup>
         <j:forEach var="c" items="${model.columns}">
           <col class="col-width-${c.width}"/>

src/main/webapp/css/jenkins-style.css

@@ -52,7 +52,9 @@ div.details-control {
 /* ------------------------------------------------------------------------------------------------------------------- */
 /* Custom column widths for property tables                                                                            */
 /* ------------------------------------------------------------------------------------------------------------------- */
-
+.col-width-0 {
+    width: 0%;
+}
 .col-width-1 {
     width: 8.333333%;
 }

src/main/webapp/js/table.js

@@ -40,6 +40,12 @@ jQuery3(document).ready(function () {
                                 return data;
                             }
                         }
+                    },
+                    {
+                        targets: 'hidden', // All columns with the '.hidden' class in the <th>
+                        visible: false,
+                        searchable: true,
+                        orderable: false // There is no point in allowing sort by this column if it's not visible.
                     }
                 ],
                 columns: JSON.parse(table.attr('data-columns-definition'))

src/test/java/io/jenkins/plugins/datatables/TableColumnTest.java

@@ -65,4 +65,19 @@ void shouldCreateDetailsColumnDiv() {
                         + "</svg>"
                         + "</div>");
     }
+
+    @Test
+    void shouldCreateHiddenColumn() {
+        TableColumn column = new TableColumn(LABEL, "Hidden", "String")
+                .setHeaderClass(ColumnCss.HIDDEN)
+                .setWidth(0);
+
+        assertThat(column).hasHeaderLabel(LABEL);
+        assertThat(column).hasDefinition("{  \"type\": \"String\",  "
+                + "\"data\": \"Hidden\",  "
+                + "\"defaultContent\": \"\",  "
+                + "\"render\": {     \"_\": \"display\",     \"sort\": \"sort\"  }}");
+        assertThat(column).hasHeaderClass("hidden");
+        assertThat(column).hasWidth(0);
+    }
 }