From 6ce30e39fc199c487f43d98a48753f0f74ebe465 Mon Sep 17 00:00:00 2001
From: cagataycivici <cagatay.civici@gmail.com>
Date: Mon, 18 Nov 2019 10:42:32 +0300
Subject: [PATCH] Refactored Table Header into a separate component

---
 src/components/datatable/DataTable.vue      | 153 ++++++------------
 src/components/datatable/ScrollableView.vue |  14 ++
 src/components/datatable/TableHeader.vue    | 162 ++++++++++++++++++++
 src/router.js                               |   5 +
 src/views/datatable/DataTableScrollDemo.vue |  60 ++++++++
 src/views/datatable/DataTableSubMenu.vue    |   1 +
 6 files changed, 287 insertions(+), 108 deletions(-)
 create mode 100644 src/components/datatable/ScrollableView.vue
 create mode 100644 src/components/datatable/TableHeader.vue
 create mode 100644 src/views/datatable/DataTableScrollDemo.vue

diff --git a/src/components/datatable/DataTable.vue b/src/components/datatable/DataTable.vue
index e1fe970ae..7d25d2302 100644
--- a/src/components/datatable/DataTable.vue
+++ b/src/components/datatable/DataTable.vue
@@ -7,51 +7,26 @@
                 <i :class="loadingIconClass"></i>
             </div>
         </div>
+        <div class="p-datatable-header" v-if="$scopedSlots.header">
+            <slot name="header"></slot>
+        </div>
+        <DTPaginator v-if="paginatorTop" :rows="d_rows" :first="d_first" :totalRecords="totalRecordsLength" :pageLinkSize="pageLinkSize" :template="paginatorTemplate" :rowsPerPageOptions="rowsPerPageOptions"
+                :currentPageReportTemplate="currentPageReportTemplate" class="p-paginator-top" @page="onPage($event)" :alwaysShow="alwaysShowPaginator">
+            <template #left v-if="$scopedSlots.paginatorLeft">
+                <slot name="paginatorLeft"></slot>
+            </template>
+            <template #right v-if="$scopedSlots.paginatorRight">
+                <slot name="paginatorRight"></slot>
+            </template>
+        </DTPaginator>
         <div class="p-datatable-wrapper">
-            <div class="p-datatable-header" v-if="$scopedSlots.header">
-                <slot name="header"></slot>
-            </div>
-            <DTPaginator v-if="paginatorTop" :rows="d_rows" :first="d_first" :totalRecords="totalRecordsLength" :pageLinkSize="pageLinkSize" :template="paginatorTemplate" :rowsPerPageOptions="rowsPerPageOptions"
-					:currentPageReportTemplate="currentPageReportTemplate" class="p-paginator-top" @page="onPage($event)" :alwaysShow="alwaysShowPaginator">
-                <template #left v-if="$scopedSlots.paginatorLeft">
-                    <slot name="paginatorLeft"></slot>
-                </template>
-                <template #right v-if="$scopedSlots.paginatorRight">
-                    <slot name="paginatorRight"></slot>
-                </template>
-            </DTPaginator>
             <table ref="table">
-                <thead class="p-datatable-thead">
-                    <tr v-if="!headerColumnGroup">
-                        <template v-for="(col,i) of columns">
-                            <th v-if="rowGroupMode !== 'subheader' || (groupRowsBy !== col.field)"
-                                :key="col.columnKey||col.field||i" :style="col.headerStyle" :class="getColumnHeaderClass(col)"
-                                @click="onColumnHeaderClick($event, col)" @mousedown="onColumnHeaderMouseDown($event, col)"
-                                @dragstart="onColumnHeaderDragStart($event)" @dragover="onColumnHeaderDragOver($event)" @dragleave="onColumnHeaderDragLeave($event)" @drop="onColumnHeaderDrop($event)"
-                                :colspan="col.colspan" :rowspan="col.rowspan">
-                                <span class="p-column-resizer p-clickable" @mousedown="onColumnResizeStart" v-if="resizableColumns"></span>
-                                <ColumnSlot :column="col" type="header" v-if="col.$scopedSlots.header" />
-                                <span class="p-column-title" v-if="col.header">{{col.header}}</span>
-                                <span v-if="col.sortable" :class="getSortableColumnIcon(col)"></span>
-                                <ColumnSlot :column="col" type="filter" v-if="col.$scopedSlots.filter" />
-                                <DTHeaderCheckbox :checked="allRowsSelected" @change="toggleRowsWithCheckbox" :disabled="empty" v-if="col.selectionMode ==='multiple'" />
-                            </th>
-                        </template>
-                    </tr>
-                    <template v-else>
-                        <tr v-for="(row,i) of headerColumnGroup.rows" :key="i">
-                            <th v-for="(col,i) of row.columns" :key="col.columnKey||col.field||i" :style="col.headerStyle" :class="getColumnHeaderClass(col)"
-                            @dragstart="onColumnHeaderDragStart($event)" @dragover="onColumnHeaderDragOver($event)" @dragleave="onColumnHeaderDragLeave($event)" @drop="onColumnHeaderDrop($event)"
-                                :colspan="col.colspan" :rowspan="col.rowspan">
-                                <ColumnSlot :column="col" type="header" v-if="col.$scopedSlots.header" />
-                                <span class="p-column-title" v-if="col.header">{{col.header}}</span>
-                                <span v-if="col.sortable" :class="getSortableColumnIcon(col)"></span>
-                                <ColumnSlot :column="col" type="filter" v-if="col.$scopedSlots.filter" />
-                                <DTHeaderCheckbox :checked="allRowsSelected" @change="toggleRowsWithCheckbox" :disabled="empty" v-if="col.selectionMode ==='multiple'" />
-                            </th>
-                        </tr>
-                    </template>
-                </thead>
+                <DTTableHeader :columnGroup="headerColumnGroup" :columns="columns" :rowGroupMode="rowGroupMode"
+                        :groupRowsBy="groupRowsBy" :resizableColumns="resizableColumns" :allRowsSelected="allRowsSelected" :empty="empty"
+                        :sortMode="sortMode" :sortField="d_sortField" :sortOrder="d_sortOrder" :multiSortMeta="d_multiSortMeta"
+                        @column-click="onColumnHeaderClick($event)"  @column-mousedown="onColumnHeaderMouseDown($event)"
+                        @column-dragstart="onColumnHeaderDragStart($event)" @column-dragover="onColumnHeaderDragOver($event)" @column-dragleave="onColumnHeaderDragLeave($event)" @column-drop="onColumnHeaderDrop($event)"
+                        @column-resizestart="onColumnResizeStart($event)" @checkbox-change="toggleRowsWithCheckbox($event)" />
                 <tbody class="p-datatable-tbody">
                     <template v-if="!empty">
                         <template v-for="(rowData, index) of dataToRender">
@@ -113,18 +88,18 @@
                     </template>
                 </tfoot>
             </table>
-            <DTPaginator v-if="paginatorBottom" :rows="d_rows" :first="d_first" :totalRecords="totalRecordsLength" :pageLinkSize="pageLinkSize" :template="paginatorTemplate" :rowsPerPageOptions="rowsPerPageOptions"
-					:currentPageReportTemplate="currentPageReportTemplate" class="p-paginator-bottom" @page="onPage($event)" :alwaysShow="alwaysShowPaginator">
-                <template #left v-if="$scopedSlots.paginatorLeft">
-                    <slot name="paginatorLeft"></slot>
-                </template>
-                <template #right v-if="$scopedSlots.paginatorRight">
-                    <slot name="paginatorRight"></slot>
-                </template>
-            </DTPaginator>
-            <div class="p-datatable-footer" v-if="$scopedSlots.footer">
-                <slot name="footer"></slot>
-            </div>
+        </div>
+        <DTPaginator v-if="paginatorBottom" :rows="d_rows" :first="d_first" :totalRecords="totalRecordsLength" :pageLinkSize="pageLinkSize" :template="paginatorTemplate" :rowsPerPageOptions="rowsPerPageOptions"
+                :currentPageReportTemplate="currentPageReportTemplate" class="p-paginator-bottom" @page="onPage($event)" :alwaysShow="alwaysShowPaginator">
+            <template #left v-if="$scopedSlots.paginatorLeft">
+                <slot name="paginatorLeft"></slot>
+            </template>
+            <template #right v-if="$scopedSlots.paginatorRight">
+                <slot name="paginatorRight"></slot>
+            </template>
+        </DTPaginator>
+        <div class="p-datatable-footer" v-if="$scopedSlots.footer">
+            <slot name="footer"></slot>
         </div>
         <div ref="resizeHelper" class="p-column-resizer-helper p-highlight" style="display: none"></div>
         <span ref="reorderIndicatorUp" class="pi pi-arrow-down p-datatable-reorder-indicator-up" style="position: absolute; display: none" v-if="reorderableColumns" />
@@ -137,9 +112,10 @@ import ObjectUtils from '../utils/ObjectUtils';
 import FilterUtils from '../utils/FilterUtils';
 import DomHandler from '../utils/DomHandler';
 import Paginator from '../paginator/Paginator';
-import HeaderCheckbox from './HeaderCheckbox.vue';
 import ColumnSlot from './ColumnSlot.vue';
 import BodyCell from './BodyCell.vue';
+//import ScrollableView from './ScrollableView.vue';
+import TableHeader from './TableHeader.vue';
 
 export default {
     props: {
@@ -426,7 +402,10 @@ export default {
             this.$emit('update:rows', this.d_rows);
             this.$emit('page', event);
         },
-        onColumnHeaderClick(event, column) {
+        onColumnHeaderClick(e) {
+            const event = e.originalEvent;
+            const column = e.column;
+
             if (column.sortable) {
                 const targetNode = event.target;
                 const columnField = column.field || column.sortField;
@@ -515,51 +494,6 @@ export default {
 
             return (this.d_multiSortMeta[index].order * result);
         },
-        getMultiSortMetaIndex(column) {
-            let index = -1;
-
-            for (let i = 0; i < this.d_multiSortMeta.length; i++) {
-                let meta = this.d_multiSortMeta[i];
-                if (meta.field === (column.field || column.sortField)) {
-                    index = i;
-                    break;
-                }
-            }
-
-            return index;
-        },
-        getColumnHeaderClass(column) {
-            const sorted = this.sortMode === 'single' ? (this.d_sortField === (column.field || column.sortField)) : this.getMultiSortMetaIndex(column) > -1;
-
-            return [column.headerClass,
-                    {'p-sortable-column': column.sortable},
-                    {'p-resizable-column': this.resizableColumns},
-                    {'p-highlight': sorted}
-            ];
-        },
-        getSortableColumnIcon(column) {
-            let sorted = false;
-            let sortOrder = null;
-
-            if (this.sortMode === 'single') {
-                sorted =  this.d_sortField === (column.field || column.sortField);
-                sortOrder = sorted ? this.d_sortOrder: 0;
-            }
-            else if (this.sortMode === 'multiple') {
-                let metaIndex = this.getMultiSortMetaIndex(column);
-                if (metaIndex > -1) {
-                    sorted = true;
-                    sortOrder = this.d_multiSortMeta[metaIndex].order;
-                }
-            }
-
-            return [
-                'p-sortable-column-icon pi pi-fw',
-                {'pi-sort': !sorted},
-                {'pi-sort-up': sorted && sortOrder > 0},
-                {'pi-sort-down': sorted && sortOrder < 0},
-            ];
-        },
         addSortMeta(meta) {
             let index = -1;
             for (let i = 0; i < this.d_multiSortMeta.length; i++) {
@@ -1117,8 +1051,11 @@ export default {
                  this.documentColumnResizeEndListener = null;
             }
         },
-        onColumnHeaderMouseDown(event, col) {
-            if (this.reorderableColumns && col.reorderableColumn) {
+        onColumnHeaderMouseDown(e) {
+            const event = e.originalEvent;
+            const column = e.column;
+
+            if (this.reorderableColumns && column.reorderableColumn) {
                 if (event.target.nodeName === 'INPUT' || event.target.nodeName === 'TEXTAREA' || DomHandler.hasClass(event.target, 'p-column-resizer'))
                     event.currentTarget.draggable = false;
                 else
@@ -1126,7 +1063,7 @@ export default {
             }
         },
         onColumnHeaderDragStart(event) {
-            if(this.columnResizing) {
+            if (this.columnResizing) {
                 event.preventDefault();
                 return;
             }
@@ -1784,8 +1721,9 @@ export default {
     components: {
         'ColumnSlot': ColumnSlot,
         'DTPaginator': Paginator,
-        'DTHeaderCheckbox': HeaderCheckbox,
-        'DTBodyCell': BodyCell
+        'DTBodyCell': BodyCell,
+        //'DTScrollableView': ScrollableView,
+        'DTTableHeader': TableHeader
     }
 }
 </script>
@@ -1972,5 +1910,4 @@ export default {
 .p-datatable .p-datatable-loading-icon {
     font-size: 2em;
 }
-
 </style>
diff --git a/src/components/datatable/ScrollableView.vue b/src/components/datatable/ScrollableView.vue
new file mode 100644
index 000000000..10b7fa2cb
--- /dev/null
+++ b/src/components/datatable/ScrollableView.vue
@@ -0,0 +1,14 @@
+<template>
+    <div></div>
+</template>
+
+<script>
+export default {
+    props: {
+
+    },
+    methods: {
+
+    }
+}
+</script>
\ No newline at end of file
diff --git a/src/components/datatable/TableHeader.vue b/src/components/datatable/TableHeader.vue
new file mode 100644
index 000000000..c8bd17779
--- /dev/null
+++ b/src/components/datatable/TableHeader.vue
@@ -0,0 +1,162 @@
+<template>
+    <thead class="p-datatable-thead">
+        <tr v-if="!columnGroup">
+            <template v-for="(col,i) of columns">
+                <th v-if="rowGroupMode !== 'subheader' || (groupRowsBy !== col.field)"
+                    :key="col.columnKey||col.field||i" :style="col.headerStyle" :class="getColumnHeaderClass(col)"
+                    @click="onColumnHeaderClick($event, col)" @mousedown="onColumnHeaderMouseDown($event, col)"
+                    @dragstart="onColumnHeaderDragStart($event)" @dragover="onColumnHeaderDragOver($event)" @dragleave="onColumnHeaderDragLeave($event)" @drop="onColumnHeaderDrop($event)"
+                    :colspan="col.colspan" :rowspan="col.rowspan">
+                    <span class="p-column-resizer p-clickable" @mousedown="onColumnResizeStart($event)" v-if="resizableColumns"></span>
+                    <DTColumnSlot :column="col" type="header" v-if="col.$scopedSlots.header" />
+                    <span class="p-column-title" v-if="col.header">{{col.header}}</span>
+                    <span v-if="col.sortable" :class="getSortableColumnIcon(col)"></span>
+                    <DTColumnSlot :column="col" type="filter" v-if="col.$scopedSlots.filter" />
+                    <DTHeaderCheckbox :checked="allRowsSelected" @change="onHeaderCheckboxChange($event)" :disabled="empty" v-if="col.selectionMode ==='multiple'" />
+                </th>
+            </template>
+        </tr>
+        <template v-else>
+            <tr v-for="(row,i) of columnGroup.rows" :key="i">
+                <th v-for="(col,i) of row.columns" :key="col.columnKey||col.field||i" :style="col.headerStyle" :class="getColumnHeaderClass(col)"
+                @dragstart="onColumnHeaderDragStart($event)" @dragover="onColumnHeaderDragOver($event)" @dragleave="onColumnHeaderDragLeave($event)" @drop="onColumnHeaderDrop($event)"
+                    :colspan="col.colspan" :rowspan="col.rowspan">
+                    <ColumnSlot :column="col" type="header" v-if="col.$scopedSlots.header" />
+                    <span class="p-column-title" v-if="col.header">{{col.header}}</span>
+                    <span v-if="col.sortable" :class="getSortableColumnIcon(col)"></span>
+                    <DTColumnSlot :column="col" type="filter" v-if="col.$scopedSlots.filter" />
+                    <DTHeaderCheckbox :checked="allRowsSelected" @change="onHeaderCheckboxChange($event)" :disabled="empty" v-if="col.selectionMode ==='multiple'" />
+                </th>
+            </tr>
+        </template>
+    </thead>
+</template>
+
+<script>
+import ColumnSlot from './ColumnSlot.vue';
+import HeaderCheckbox from './HeaderCheckbox.vue';
+
+export default {
+    props: {
+		columnGroup: {
+            type: null,
+            default: null
+        },
+        columns: {
+            type: null,
+            default: null
+        },
+        rowGroupMode: {
+            type: String,
+            default: null
+        },
+        groupRowsBy: {
+            type: [Array,String],
+            default: null
+        },
+        resizableColumns: {
+            type: Boolean,
+            default: false
+        },
+        allRowsSelected: {
+            type: Boolean,
+            default: false
+        },
+        empty: {
+            type: Boolean,
+            default: false
+        },
+        sortMode: {
+            type: String,
+            default: 'single'
+        },
+        sortField: {
+            type: String,
+            default: null
+        },
+        sortOrder: {
+            type: Number,
+            default: null
+        },
+        multiSortMeta: {
+            type: Array,
+            default: null
+        }
+    },
+    methods: {
+        getColumnHeaderClass(column) {
+            const sorted = this.sortMode === 'single' ? (this.sortField === (column.field || column.sortField)) : this.getMultiSortMetaIndex(column) > -1;
+
+            return [column.headerClass,
+                    {'p-sortable-column': column.sortable},
+                    {'p-resizable-column': this.resizableColumns},
+                    {'p-highlight': sorted}
+            ];
+        },
+        getSortableColumnIcon(column) {
+            let sorted = false;
+            let sortOrder = null;
+
+            if (this.sortMode === 'single') {
+                sorted =  this.sortField === (column.field || column.sortField);
+                sortOrder = sorted ? this.sortOrder: 0;
+            }
+            else if (this.sortMode === 'multiple') {
+                let metaIndex = this.getMultiSortMetaIndex(column);
+                if (metaIndex > -1) {
+                    sorted = true;
+                    sortOrder = this.multiSortMeta[metaIndex].order;
+                }
+            }
+
+            return [
+                'p-sortable-column-icon pi pi-fw',
+                {'pi-sort': !sorted},
+                {'pi-sort-up': sorted && sortOrder > 0},
+                {'pi-sort-down': sorted && sortOrder < 0},
+            ];
+        },
+        getMultiSortMetaIndex(column) {
+            let index = -1;
+
+            for (let i = 0; i < this.multiSortMeta.length; i++) {
+                let meta = this.multiSortMeta[i];
+                if (meta.field === (column.field || column.sortField)) {
+                    index = i;
+                    break;
+                }
+            }
+
+            return index;
+        },
+        onColumnHeaderClick(event, col) {
+            this.$emit('column-click', {originalEvent: event, column: col});
+        },
+        onColumnHeaderMouseDown(event, col) {
+            this.$emit('column-mousedown', {originalEvent: event, column: col});
+        },
+        onColumnHeaderDragStart(event) {
+            this.$emit('column-dragstart', event);
+        },
+        onColumnHeaderDragOver(event) {
+            this.$emit('column-dragover', event);
+        },
+        onColumnHeaderDragLeave(event) {
+            this.$emit('column-dragleave', event);
+        },
+        onColumnHeaderDrop(event) {
+            this.$emit('column-drop', event);
+        },
+        onColumnResizeStart(event) {
+            this.$emit('column-resizestart', event);
+        },
+        onHeaderCheckboxChange(event) {
+            this.$emit('checkbox-change', event);
+        }
+    },
+    components: {
+        'DTColumnSlot': ColumnSlot,
+        'DTHeaderCheckbox': HeaderCheckbox
+    }
+}
+</script>
\ No newline at end of file
diff --git a/src/router.js b/src/router.js
index 8f4ee7072..690664bd5 100644
--- a/src/router.js
+++ b/src/router.js
@@ -201,6 +201,11 @@ export default new Router({
 			name: 'datatablecrud',
 			component: () => import('./views/datatable/DataTableCrudDemo.vue')
         },
+        {
+			path: '/datatable/scroll',
+			name: 'datatablescroll',
+			component: () => import('./views/datatable/DataTableScrollDemo.vue')
+        },
         {
 			path: '/datatable/style',
 			name: 'datatablestyle',
diff --git a/src/views/datatable/DataTableScrollDemo.vue b/src/views/datatable/DataTableScrollDemo.vue
new file mode 100644
index 000000000..d01e3716d
--- /dev/null
+++ b/src/views/datatable/DataTableScrollDemo.vue
@@ -0,0 +1,60 @@
+<template>
+	<div>
+        <DataTableSubMenu />
+
+		<div class="content-section introduction">
+			<div class="feature-intro">
+				<h1>DataTable - Scroll</h1>
+				<p>Data scrolling is available horizontally, vertically or both. Virtual Scrolling mode is also provided to deal with large datasets by loading data on demand during scrolling.</p>
+			</div>
+		</div>
+
+		<div class="content-section implementation">
+            <h3>Vertical</h3>
+			<DataTable :value="cars">
+                <Column field="vin" header="Vin"></Column>
+                <Column field="year" header="Year"></Column>
+                <Column field="brand" header="Brand"></Column>
+                <Column field="color" header="Color"></Column>
+            </DataTable>
+		</div>
+
+        <div class="content-section documentation">
+            <TabView>
+                <TabPanel header="Source">
+<CodeHighlight>
+<template v-pre>
+</template>
+</CodeHighlight>
+
+<CodeHighlight lang="javascript">
+
+</CodeHighlight>
+                </TabPanel>
+            </TabView>
+        </div>
+	</div>
+</template>
+
+<script>
+import CarService from '../../service/CarService';
+import DataTableSubMenu from './DataTableSubMenu';
+
+export default {
+    data() {
+        return {
+            cars: null
+        }
+    },
+    carService: null,
+    created() {
+        this.carService = new CarService();
+    },
+    mounted() {
+        this.carService.getCarsLarge().then(data => this.cars = data);
+    },
+    components: {
+        'DataTableSubMenu': DataTableSubMenu
+    }
+}
+</script>
\ No newline at end of file
diff --git a/src/views/datatable/DataTableSubMenu.vue b/src/views/datatable/DataTableSubMenu.vue
index d9193ac93..cc8846de7 100644
--- a/src/views/datatable/DataTableSubMenu.vue
+++ b/src/views/datatable/DataTableSubMenu.vue
@@ -9,6 +9,7 @@
             <li><router-link to="/datatable/filter">&#9679; Filter</router-link></li>
             <li><router-link to="/datatable/selection">&#9679; Selection</router-link></li>
             <li><router-link to="/datatable/lazy">&#9679; Lazy</router-link></li>
+            <li><router-link to="/datatable/scroll">&#9679; Scroll</router-link></li>
             <li><router-link to="/datatable/rowexpand">&#9679; Expand</router-link></li>
             <li><router-link to="/datatable/edit">&#9679; Edit</router-link></li>
             <li><router-link to="/datatable/coltoggle">&#9679; ColToggle</router-link></li>