/*******************************************************************************
 * Breakout Cave Survey Visualizer
 *
 * Copyright (C) 2014 James Edwards
 *
 * jedwards8 at fastmail dot fm
 *
 * 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 2 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, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *******************************************************************************/
package org.andork.swing.table;

import javax.swing.ListModel;
import javax.swing.RowSorter;
import javax.swing.event.EventListenerList;
import javax.swing.event.ListDataEvent;
import javax.swing.event.ListDataListener;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
import javax.swing.event.RowSorterEvent;
import javax.swing.event.RowSorterListener;
import javax.swing.event.TableModelEvent;
import javax.swing.event.TableModelListener;
import javax.swing.table.TableModel;

/**
 * A ListModel that is based upon a {@link TableModel}. It will listen to the
 * model for {@link TableModelEvent}s and fire corresponding
 * {@link ListDataEvent}s. By default {@link #getElementAt(int)} just returns
 * values in column 0 of the model, but derived classes may override it to
 * return other values.
 *
 * @author andy.edwards
 */
public class AnnotatingJTableJumpBarModel implements ListModel {
	protected class ChangeHandler implements TableModelListener, RowSorterListener, ListSelectionListener {
		@Override
		public void sorterChanged(RowSorterEvent e) {
			fireContentsChanged(0, table.getRowCount());
		}

		@Override
		public void tableChanged(TableModelEvent e) {
			if (rowSorter != null) {
				return;
			}
			switch (e.getType()) {
			case TableModelEvent.INSERT:
				fireIntervalAdded(e.getFirstRow(), e.getLastRow());
				break;
			case TableModelEvent.UPDATE:
				fireContentsChanged(0, table.getRowCount());
				break;
			case TableModelEvent.DELETE:
				fireIntervalRemoved(e.getFirstRow(), e.getLastRow());
				break;
			}
		}

		@Override
		public void valueChanged(ListSelectionEvent e) {
			fireContentsChanged(e.getFirstIndex(), e.getLastIndex());
		}
	}

	protected AnnotatingJTable table;
	protected TableModel tableModel;

	protected RowSorter<?> rowSorter;

	/** List of listeners */
	protected EventListenerList listenerList = new EventListenerList();

	protected ChangeHandler changeHandler = new ChangeHandler();

	public AnnotatingJTableJumpBarModel(AnnotatingJTable table) {
		this.table = table;
		tableModel = table.getModel();
		tableModel.addTableModelListener(changeHandler);
		table.getSelectionModel().addListSelectionListener(changeHandler);
		rowSorter = table.getRowSorter();
		if (rowSorter != null) {
			rowSorter.addRowSorterListener(changeHandler);
		}
	}

	@Override
	public void addListDataListener(ListDataListener l) {
		listenerList.add(ListDataListener.class, l);
	}

	public void destroy() {
		tableModel.removeTableModelListener(changeHandler);
		tableModel = null;
		table.getSelectionModel().removeListSelectionListener(changeHandler);
		table = null;
		if (rowSorter != null) {
			rowSorter.removeRowSorterListener(changeHandler);
			rowSorter = null;
		}
	}

	protected void fireContentsChanged(int index0, int index1) {
		ListDataEvent event = new ListDataEvent(this, ListDataEvent.CONTENTS_CHANGED, index0, index1);
		// Guaranteed to return a non-null array
		Object[] listeners = listenerList.getListenerList();
		// Process the listeners last to first, notifying
		// those that are interested in this event
		for (int i = listeners.length - 2; i >= 0; i -= 2) {
			if (listeners[i] == ListDataListener.class) {
				ListDataListener listener = (ListDataListener) listeners[i + 1];
				listener.contentsChanged(event);
			}
		}
	}

	protected void fireIntervalAdded(int index0, int index1) {
		ListDataEvent event = new ListDataEvent(this, ListDataEvent.INTERVAL_ADDED, index0, index1);
		// Guaranteed to return a non-null array
		Object[] listeners = listenerList.getListenerList();
		// Process the listeners last to first, notifying
		// those that are interested in this event
		for (int i = listeners.length - 2; i >= 0; i -= 2) {
			if (listeners[i] == ListDataListener.class) {
				ListDataListener listener = (ListDataListener) listeners[i + 1];
				listener.contentsChanged(event);
			}
		}
	}

	protected void fireIntervalRemoved(int index0, int index1) {
		ListDataEvent event = new ListDataEvent(this, ListDataEvent.INTERVAL_REMOVED, index0, index1);
		// Guaranteed to return a non-null array
		Object[] listeners = listenerList.getListenerList();
		// Process the listeners last to first, notifying
		// those that are interested in this event
		for (int i = listeners.length - 2; i >= 0; i -= 2) {
			if (listeners[i] == ListDataListener.class) {
				ListDataListener listener = (ListDataListener) listeners[i + 1];
				listener.contentsChanged(event);
			}
		}
	}

	@Override
	public Object getElementAt(int index) {
		if (table.isRowSelected(index)) {
			return table.getSelectionBackground();
		}
		return table.getAnnotation(index);
	}

	public ListDataListener[] getListDataListeners() {
		return listenerList.getListeners(
				ListDataListener.class);
	}

	@Override
	public int getSize() {
		return table.getRowCount();
	}

	@Override
	public void removeListDataListener(ListDataListener l) {
		listenerList.remove(ListDataListener.class, l);
	}
}