SEURAT.search.SearchResultPage_StringTableSorter.java Source code

Introduction

Here is the source code for SEURAT.search.SearchResultPage_StringTableSorter.java

Source

/*   This code belongs to the SEURAT project as written by Dr. Janet Burge
Copyright (C) 2013  Janet Burge
    
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
    
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
    
You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>. */

package SEURAT.search;

import org.eclipse.jface.viewers.*;
import org.eclipse.jface.viewers.ViewerComparator;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;

import SEURAT.search.commonArguments.CommonArgumentSearchResultMatch;

/**
 * Implementation of ViewerComparator and SelectionListener interfaces
 * allowing a TableViewer to sort a table column on the strings
 * displayed in that column.
 * 
 * @author hannasm
 */
public class SearchResultPage_StringTableSorter extends ViewerComparator implements SelectionListener {
    private int m_SortColumn;
    private TableViewer m_TableViewer;
    private ITableLabelProvider m_TableLabelProvider;
    private boolean m_ReverseDirection;

    /**
     * @param pSortColumn the id of the table column to sort on
     * @param pViewer the table viewer which will be sorted
     */
    public SearchResultPage_StringTableSorter(int pSortColumn, TableViewer pViewer) {
        super();
        m_SortColumn = pSortColumn;
        m_TableViewer = pViewer;
        m_TableLabelProvider = ((ITableLabelProvider) pViewer.getLabelProvider());

        // Initialize To True, Then When Activated For The First Time Direction
        // Will Not Be Reversed
        m_ReverseDirection = true;
    }

    /* Compare our elements
     * Method declared on ViewerSorter.
     */
    public int compare(Viewer pViewer, Object pOne, Object pTwo) {
        // Leverage the label provider to make this function really simple
        int l_result = m_TableLabelProvider.getColumnText(pOne, m_SortColumn)
                .compareTo(m_TableLabelProvider.getColumnText(pTwo, m_SortColumn));

        if (m_ReverseDirection)
            l_result = -l_result;

        return l_result;
    }

    /* (non-Javadoc)
     * @see org.eclipse.swt.events.SelectionListener#widgetDefaultSelected(org.eclipse.swt.events.SelectionEvent)
     */
    public void widgetDefaultSelected(SelectionEvent pEvent) {
        widgetSelected(pEvent);
    }

    /* 
     * Reverses the sorting each click.
     * 
     * (non-Javadoc)
     * @see org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt.events.SelectionEvent)
     */
    public void widgetSelected(SelectionEvent pEvent) {
        m_ReverseDirection = !m_ReverseDirection;
        m_TableViewer.setComparator(this);
        m_TableViewer.refresh();
    }
}