org.eclipse.jface.snippets.viewers.Snippet040TableViewerSorting.java Source code

Java tutorial

Introduction

Here is the source code for org.eclipse.jface.snippets.viewers.Snippet040TableViewerSorting.java

Source

/*******************************************************************************
 * Copyright (c) 2006, 2014 Tom Schindl and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     Tom Schindl - initial API and implementation
 *     Lars Vogel (lars.vogel@gmail.com) - Bug 413427
 *     Jeanderson Candido (http://jeandersonbc.github.io) - Bug 414565
 *******************************************************************************/

package org.eclipse.jface.snippets.viewers;

import org.eclipse.jface.viewers.ArrayContentProvider;
import org.eclipse.jface.viewers.CellEditor;
import org.eclipse.jface.viewers.ColumnLabelProvider;
import org.eclipse.jface.viewers.ColumnViewer;
import org.eclipse.jface.viewers.EditingSupport;
import org.eclipse.jface.viewers.TableViewer;
import org.eclipse.jface.viewers.TableViewerColumn;
import org.eclipse.jface.viewers.TextCellEditor;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerComparator;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.FillLayout;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Table;

/**
 * Example usage of ViewerComparator in tables to allow sorting
 *
 * @author Tom Schindl <tom.schindl@bestsolution.at>
 *
 */
public class Snippet040TableViewerSorting {

    public class Person {
        public String givenname;
        public String surname;
        public String email;

        public Person(String givenname, String surname, String email) {
            this.givenname = givenname;
            this.surname = surname;
            this.email = email;
        }
    }

    protected abstract class AbstractEditingSupport extends EditingSupport {
        private TextCellEditor editor;

        public AbstractEditingSupport(TableViewer viewer) {
            super(viewer);
            this.editor = new TextCellEditor(viewer.getTable());
        }

        @Override
        protected boolean canEdit(Object element) {
            return true;
        }

        @Override
        protected CellEditor getCellEditor(Object element) {
            return editor;
        }

        @Override
        protected void setValue(Object element, Object value) {
            doSetValue(element, value);
            getViewer().update(element, null);
        }

        protected abstract void doSetValue(Object element, Object value);
    }

    public Snippet040TableViewerSorting(Shell shell) {
        TableViewer viewer = new TableViewer(shell, SWT.BORDER | SWT.FULL_SELECTION);
        viewer.setContentProvider(ArrayContentProvider.getInstance());

        TableViewerColumn column = createColumnFor(viewer, "Givenname");
        column.setLabelProvider(new ColumnLabelProvider() {

            @Override
            public String getText(Object element) {
                return ((Person) element).givenname;
            }
        });

        column.setEditingSupport(new AbstractEditingSupport(viewer) {

            @Override
            protected Object getValue(Object element) {
                return ((Person) element).givenname;
            }

            @Override
            protected void doSetValue(Object element, Object value) {
                ((Person) element).givenname = value.toString();
            }

        });

        ColumnViewerComparator cSorter = new ColumnViewerComparator(viewer, column) {

            @Override
            protected int doCompare(Viewer viewer, Object e1, Object e2) {
                Person p1 = (Person) e1;
                Person p2 = (Person) e2;
                return p1.givenname.compareToIgnoreCase(p2.givenname);
            }

        };

        column = createColumnFor(viewer, "Surname");
        column.setLabelProvider(new ColumnLabelProvider() {

            @Override
            public String getText(Object element) {
                return ((Person) element).surname;
            }

        });

        column.setEditingSupport(new AbstractEditingSupport(viewer) {

            @Override
            protected Object getValue(Object element) {
                return ((Person) element).surname;
            }

            @Override
            protected void doSetValue(Object element, Object value) {
                ((Person) element).surname = value.toString();
            }

        });

        new ColumnViewerComparator(viewer, column) {

            @Override
            protected int doCompare(Viewer viewer, Object e1, Object e2) {
                Person p1 = (Person) e1;
                Person p2 = (Person) e2;
                return p1.surname.compareToIgnoreCase(p2.surname);
            }

        };

        column = createColumnFor(viewer, "E-Mail");
        column.setLabelProvider(new ColumnLabelProvider() {

            @Override
            public String getText(Object element) {
                return ((Person) element).email;
            }

        });

        column.setEditingSupport(new AbstractEditingSupport(viewer) {

            @Override
            protected Object getValue(Object element) {
                return ((Person) element).email;
            }

            @Override
            protected void doSetValue(Object element, Object value) {
                ((Person) element).email = value.toString();
            }

        });

        new ColumnViewerComparator(viewer, column) {

            @Override
            protected int doCompare(Viewer viewer, Object e1, Object e2) {
                Person p1 = (Person) e1;
                Person p2 = (Person) e2;
                return p1.email.compareToIgnoreCase(p2.email);
            }

        };

        viewer.setInput(createModel());
        viewer.getTable().setLinesVisible(true);
        viewer.getTable().setHeaderVisible(true);
        cSorter.setSorter(cSorter, ColumnViewerComparator.ASC);
    }

    private TableViewerColumn createColumnFor(TableViewer viewer, String label) {
        TableViewerColumn column = new TableViewerColumn(viewer, SWT.NONE);
        column.getColumn().setWidth(200);
        column.getColumn().setText(label);
        column.getColumn().setMoveable(true);
        return column;
    }

    private Person[] createModel() {
        return new Person[] { new Person("Tom", "Schindl", "tom.schindl@bestsolution.at"),
                new Person("Boris", "Bokowski", "Boris_Bokowski@ca.ibm.com"),
                new Person("Tod", "Creasey", "Tod_Creasey@ca.ibm.com"),
                new Person("Wayne", "Beaton", "wayne@eclipse.org"),
                new Person("Jeanderson", "Candido", "jeandersonbc@gmail.com"),
                new Person("Lars", "Vogel", "Lars.Vogel@gmail.com"),
                new Person("Hendrik", "Still", "hendrik.still@gammas.de") };
    }

    private static abstract class ColumnViewerComparator extends ViewerComparator {

        public static final int ASC = 1;
        public static final int NONE = 0;
        public static final int DESC = -1;

        private int direction = 0;
        private TableViewerColumn column;
        private ColumnViewer viewer;

        public ColumnViewerComparator(ColumnViewer viewer, TableViewerColumn column) {
            this.column = column;
            this.viewer = viewer;
            SelectionAdapter selectionAdapter = createSelectionAdapter();
            this.column.getColumn().addSelectionListener(selectionAdapter);
        }

        private SelectionAdapter createSelectionAdapter() {
            return new SelectionAdapter() {

                @Override
                public void widgetSelected(SelectionEvent e) {
                    if (ColumnViewerComparator.this.viewer.getComparator() != null) {
                        if (ColumnViewerComparator.this.viewer.getComparator() == ColumnViewerComparator.this) {
                            int tdirection = ColumnViewerComparator.this.direction;
                            if (tdirection == ASC) {
                                setSorter(ColumnViewerComparator.this, DESC);
                            } else if (tdirection == DESC) {
                                setSorter(ColumnViewerComparator.this, NONE);
                            }
                        } else {
                            setSorter(ColumnViewerComparator.this, ASC);
                        }
                    } else {
                        setSorter(ColumnViewerComparator.this, ASC);
                    }
                }
            };
        }

        public void setSorter(ColumnViewerComparator sorter, int direction) {
            Table columnParent = column.getColumn().getParent();
            if (direction == NONE) {
                columnParent.setSortColumn(null);
                columnParent.setSortDirection(SWT.NONE);
                viewer.setComparator(null);

            } else {
                columnParent.setSortColumn(column.getColumn());
                sorter.direction = direction;
                columnParent.setSortDirection(direction == ASC ? SWT.DOWN : SWT.UP);

                if (viewer.getComparator() == sorter) {
                    viewer.refresh();
                } else {
                    viewer.setComparator(sorter);
                }

            }
        }

        @Override
        public int compare(Viewer viewer, Object e1, Object e2) {
            return direction * doCompare(viewer, e1, e2);
        }

        protected abstract int doCompare(Viewer viewer, Object e1, Object e2);
    }

    /**
     * @param args
     */
    public static void main(String[] args) {
        Display display = new Display();

        Shell shell = new Shell(display);
        shell.setLayout(new FillLayout());
        new Snippet040TableViewerSorting(shell);
        shell.open();

        while (!shell.isDisposed()) {
            if (!display.readAndDispatch())
                display.sleep();
        }
        display.dispose();
    }

}