RandomSec/main/webapp/modules/core/scripts/views/data-table/column-header-ui.js

/*

Copyright 2010, Google Inc.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

    * Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
    * Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,           
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY           
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

function DataTableColumnHeaderUI(dataTableView, column, columnIndex, td) {
    this._dataTableView = dataTableView;
    this._column = column;
    this._columnIndex = columnIndex;
    this._td = td;
    
    this._render();
}

DataTableColumnHeaderUI._extenders = [];

/*
    To extend, call
    
    DataTableColumnHeaderUI.extendMenu(function(column, columnHeaderUI, menu) {
        ...
        MenuSystem.appendTo(menu, path, newItems);
    });
*/
DataTableColumnHeaderUI.extendMenu = function(extender) {
    DataTableColumnHeaderUI._extenders.push(extender);
};

DataTableColumnHeaderUI.prototype.getColumn = function() {
    return this._column;
};

DataTableColumnHeaderUI.prototype._render = function() {
    var self = this;
    var td = $(this._td);
    
    td.html(DOM.loadHTML("core", "scripts/views/data-table/column-header.html"));
    var elmts = DOM.bind(td);
    
    elmts.nameContainer.text(this._column.name);
    elmts.dropdownMenu.click(function() {
        self._createMenuForColumnHeader(this);
    });
    
    if ("reconStats" in this._column) {
        var stats = this._column.reconStats;
        if (stats.nonBlanks > 0) {
            var newPercent = Math.ceil(100 * stats.newTopics / stats.nonBlanks);
            var matchPercent = Math.ceil(100 * stats.matchedTopics / stats.nonBlanks);
            var unreconciledPercent = Math.ceil(100 * (stats.nonBlanks - stats.matchedTopics - stats.newTopics) / stats.nonBlanks);
            var title = matchPercent + "% matched, " + newPercent + "% new, " + unreconciledPercent + "% to be reconciled";
            
            var whole = $('<div>')
                .addClass("column-header-recon-stats-bar")
                .attr("title", title)
                .appendTo(elmts.reconStatsContainer.show());
            
            $('<div>')
                .addClass("column-header-recon-stats-blanks")
                .width(Math.round((stats.newTopics + stats.matchedTopics) * 100 / stats.nonBlanks) + "%")
                .appendTo(whole);
                
            $('<div>')
                .addClass("column-header-recon-stats-matched")
                .width(Math.round(stats.matchedTopics * 100 / stats.nonBlanks) + "%")
                .appendTo(whole);
        }
    }
};

DataTableColumnHeaderUI.prototype._createMenuForColumnHeader = function(elmt) {
    var self = this;
    var menu = [
        {
            id: "core/facet",
            label: "Facet",
            width: "170px",
            submenu: []
        },
        {},
        {
            id: "core/edit-cells",
            label: "Edit Cells",
            width: "170px",
            submenu: []
        },
        {
            id: "core/edit-column",
            label: "Edit Column",
            submenu: []
        },
        {
            id: "core/transpose",
            label: "Transpose",
            submenu: []
        },
        {},
        (
            this._dataTableView._getSortingCriterionForColumn(this._column.name) == null ?
                {
                    id: "core/sort",
                    "label": "Sort ...",
                    "click": function() {
                        self._showSortingCriterion(null, self._dataTableView._getSortingCriteriaCount() > 0)
                    }
                } :
                {
                    id: "core/sort",
                    label: "Sort",
                    submenu: this.createSortingMenu()
                }
        ),
        {
            id: "core/view",
            label: "View",
            tooltip: "Collapse/expand columns to make viewing the data more convenient",
            submenu: [
                {
                    label: "Collapse This Column",
                    click: function() {
                        self._dataTableView._collapsedColumnNames[self._column.name] = true;
                        self._dataTableView.render();
                    }
                },
                {
                    label: "Collapse All Other Columns",
                    click: function() {
                        var collapsedColumnNames = {};
                        for (var i = 0; i < theProject.columnModel.columns.length; i++) {
                            if (i != self._columnIndex) {
                                collapsedColumnNames[theProject.columnModel.columns[i].name] = true;
                            }
                        }
                        self._dataTableView._collapsedColumnNames = collapsedColumnNames;
                        self._dataTableView.render();
                    }
                },
                {
                    label: "Collapse All Columns To Left",
                    click: function() {
                        for (var i = 0; i < self._columnIndex; i++) {
                            self._dataTableView._collapsedColumnNames[theProject.columnModel.columns[i].name] = true;
                        }
                        self._dataTableView.render();
                    }
                },
                {
                    label: "Collapse All Columns To Right",
                    click: function() {
                        for (var i = self._columnIndex + 1; i < theProject.columnModel.columns.length; i++) {
                            self._dataTableView._collapsedColumnNames[theProject.columnModel.columns[i].name] = true;
                        }
                        self._dataTableView.render();
                    }
                }
            ]
        },
        {},
        {
            id: "core/reconcile",
            label: "Reconcile",
            tooltip: "Match this column's cells to topics on Freebase",
            width: "170px",
            submenu: []
        }
    ];
    
    for (var i = 0; i < DataTableColumnHeaderUI._extenders.length; i++) {
        DataTableColumnHeaderUI._extenders[i].call(null, this._column, this, menu);
    }
    
    MenuSystem.createAndShowStandardMenu(menu, elmt, { width: "120px", horizontal: false });
};

DataTableColumnHeaderUI.prototype.createSortingMenu = function() {
    var self = this;
    var criterion = this._dataTableView._getSortingCriterionForColumn(this._column.name);
    var criteriaCount = this._dataTableView._getSortingCriteriaCount();
    var hasOtherCriteria = criterion == null ? (criteriaCount > 0) : criteriaCount > 1;
    
    var items = [
        {
            "label": "Sort ...",
            "click": function() {
                self._showSortingCriterion(criterion, hasOtherCriteria)
            }
        }
    ];
    
    if (criterion != null) {
        items.push({
            "label": "Reverse",
            "click": function() {
                criterion.reverse = !criterion.reverse;
                self._dataTableView._addSortingCriterion(criterion);
            }
        });
        items.push({
            "label": "Un-sort",
            "click": function() {
                self._dataTableView._removeSortingCriterionOfColumn(criterion.column);
            }
        });
    }
    
    return items;
};

DataTableColumnHeaderUI.prototype._showSortingCriterion = function(criterion, hasOtherCriteria) {
    criterion = criterion || {
        column: this._column.name,
        valueType: "string",
        caseSensitive: false,
        errorPosition: 1,
        blankPosition: 2
    };
    
    var self = this;
    var frame = $(DOM.loadHTML("core", "scripts/views/data-table/sorting-criterion-dialog.html"));
    var elmts = DOM.bind(frame);
    
    elmts.dialogHeader.text('Sort by ' + this._column.name);
    
    elmts.valueTypeOptions
        .find("input[type='radio'][value='" + criterion.valueType + "']")
        .attr("checked", "checked");
        
    var setValueType = function(valueType) {
        var forward = elmts.directionForwardLabel;
        var reverse = elmts.directionReverseLabel;
        if (valueType == "string") {
            forward.html("a - z");
            reverse.html("z - a");
        } else if (valueType == "number") {
            forward.html("smallest first");
            reverse.html("largest first");
        } else if (valueType == "date") {
            forward.html("earliest first");
            reverse.html("latest first");
        } else if (valueType == "boolean") {
            forward.html("false then true");
            reverse.html("true then false");
        }
    };
    elmts.valueTypeOptions
        .find("input[type='radio']")
        .change(function() {
            setValueType(this.value);
        });
       
    if (criterion.valueType == "string" && criterion.caseSensitive) {
        elmts.caseSensitiveCheckbox.attr("checked", "checked");
    }
    
    elmts.directionOptions
        .find("input[type='radio'][value='" + (criterion.reverse ? "reverse" : "forward") + "']")
        .attr("checked", "checked");

    if (hasOtherCriteria) {
        elmts.sortAloneContainer.show();
    }
    
    var validValuesHtml = '<li kind="value">Valid Values</li>';
    var blankValuesHtml = '<li kind="blank">Blanks</li>';
    var errorValuesHtml = '<li kind="error">Errors</li>';
    var positionsHtml;
    if (criterion.blankPosition < 0) {
        if (criterion.errorPosition > 0) {
            positionsHtml = [ blankValuesHtml, validValuesHtml, errorValuesHtml ];
        } else if (criterion.errorPosition < criterion.blankPosition) {
            positionsHtml = [ errorValuesHtml, blankValuesHtml, validValuesHtml ];
        } else {
            positionsHtml = [ blankValuesHtml, errorValuesHtml, validValuesHtml ];
        }
    } else {
        if (criterion.errorPosition < 0) {
            positionsHtml = [ errorValuesHtml, validValuesHtml, blankValuesHtml ];
        } else if (criterion.errorPosition < criterion.blankPosition) {
            positionsHtml = [ validValuesHtml, errorValuesHtml, blankValuesHtml  ];
        } else {
            positionsHtml = [ validValuesHtml, blankValuesHtml, errorValuesHtml ];
        }
    }
    elmts.blankErrorPositions.html(positionsHtml.join("")).sortable().disableSelection();
    
    var level = DialogSystem.showDialog(frame);
    var dismiss = function() { DialogSystem.dismissUntil(level - 1); };
    
    setValueType(criterion.valueType); 
    
    elmts.cancelButton.click(dismiss);
    elmts.okButton.click(function() {
        var criterion2 = {
            column: self._column.name,
            valueType: elmts.valueTypeOptions.find("input[type='radio']:checked")[0].value,
            reverse: elmts.directionOptions.find("input[type='radio']:checked")[0].value == "reverse"
        };
        
        var valuePosition, blankPosition, errorPosition;
        elmts.blankErrorPositions.find("li").each(function(index, elmt) {
            var kind = this.getAttribute("kind");
            if (kind == "value") {
                valuePosition = index;
            } else if (kind == "blank") {
                blankPosition = index;
            } else if (kind == "error") {
                errorPosition = index;
            }
        });
        criterion2.blankPosition = blankPosition - valuePosition;
        criterion2.errorPosition = errorPosition - valuePosition;
        
        if (criterion2.valueType == "string") {
            criterion2.caseSensitive = elmts.caseSensitiveCheckbox[0].checked;
        }
        
        self._dataTableView._addSortingCriterion(
            criterion2, elmts.sortAloneContainer.find("input")[0].checked);
            
        dismiss();
    });
};