path: root/dozentenmodul/src/main/java/org/openslx/dozmod/gui/control/LocationSelector.java

package org.openslx.dozmod.gui.control;

import java.awt.Component;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Enumeration;
import java.util.List;

import javax.swing.BoxLayout;
import javax.swing.ButtonGroup;
import javax.swing.DefaultListCellRenderer;
import javax.swing.DefaultListModel;
import javax.swing.JButton;
import javax.swing.JList;
import javax.swing.JPanel;
import javax.swing.JRadioButton;
import javax.swing.JScrollPane;

import org.apache.log4j.Logger;
import org.openslx.bwlp.thrift.iface.Location;
import org.openslx.dozmod.gui.Gui;
import org.openslx.dozmod.gui.helper.GridManager;
import org.openslx.dozmod.thrift.cache.MetaDataCache;
import org.openslx.util.QuickTimer;
import org.openslx.util.QuickTimer.Task;

/**
 * 
 * Widget to select the locations of a lecture. The UI is simply two JLists and
 * a button panel to move the elements from one list to the other. Use the
 * getters to read the values of the lists/checkbox: get
 * 
 * @author Jonathan Bauer
 * 
 */
public class LocationSelector extends JPanel {
	private final static Logger LOGGER = Logger
			.getLogger(LocationSelector.class);

	private DefaultListModel<Location> availableLocationModel = new DefaultListModel<Location>();
	private DefaultListModel<Location> selectedLocationModel = new DefaultListModel<Location>();

	private JButton addAllButton = new JButton(">>");
	private JButton addButton = new JButton(">");
	private JButton removeButton = new JButton("<");
	private JButton removeAllButton = new JButton("<<");
	private JRadioButton exclusivelyButton = new JRadioButton("Veranstaltung ausschließlich in den ausgewählten Räumen anzeigen");
	private JRadioButton prioritizedButton = new JRadioButton("Veranstaltung mit höherer Priorität in den ausgewählten Räumen anzeigen");

	/**
	 * Flag for the initialization state
	 */
	private boolean initDone = false;

	/**
	 * List of ID's of locations to set the selection to when we finished initializing
	 */
	private List<Integer> preselection;

	/**
	 * Getter for the available location model
	 * 
	 * @return the locationModel of the "available location" list
	 */
	public DefaultListModel<Location> getLocationModel() {
		return availableLocationModel;
	}

	/**
	 * Getter for the selected location model
	 * 
	 * @return the locationModel of the "selected location" list
	 */
	public DefaultListModel<Location> getSelectedLocationModel() {
		return selectedLocationModel;
	}

	/**
	 * Getter for the "show only in selection" checkbox
	 * 
	 * @return true if checked, false otherwise
	 */
	public boolean getOnlyInSelection() {
		return exclusivelyButton.isSelected();
	}

	/**
	 * Sets the selection to the locations corresponding to the given list of
	 * id's
	 * 
	 * @param list
	 *            of integers to set the locations to
	 */
	public void setSelectedLocationsAsIds(List<Integer> list) {
		if (list == null) {
			LOGGER.error("No list given!");
			return;
		}
		preselection = list;
		// if we are initialised, we need to explicitly set the selection
		if (initDone)
			setSelectionInternal(preselection);
	}

	/**
	 * Sets the list of available locations. Should be called with the list
	 * given by the server
	 * 
	 * @param list
	 *            of locations to set the available list to
	 * @return true if setting the list worked, false otherwise
	 */
	public boolean fillLocationsList(final List<Location> locations) {
		if (locations == null) {
			LOGGER.error("No locations returned from the metadata cache.");
			return false;
		}
		for (Location loc : locations) {
			if (loc != null) {
				LOGGER.debug("Adding: " + loc.getLocationName());
				availableLocationModel.addElement(loc);
			} else {
				LOGGER.error("One location returned from the server was null");
			}
		}
		return true;
	}

	/**
	 * Constructor. Initializes the grid layout, the location lists and
	 * initializes the data
	 */
	public LocationSelector() {
		GridManager grid = new GridManager(this, 3);
		LocationRenderer locationRenderer = new LocationRenderer();

		// the available list of locations
		final JList<Location> availableLocationList = new JList<Location>();
		availableLocationList.setCellRenderer(locationRenderer);
		availableLocationList.setModel(availableLocationModel);

		// the selected list of locations
		final JList<Location> selectedLocationList = new JList<Location>();
		selectedLocationList.setCellRenderer(locationRenderer);
		selectedLocationList.setModel(selectedLocationModel);

		// the listeners for lists
		selectedLocationList.addMouseListener(new MouseAdapter() {
			public void mouseClicked(MouseEvent e) {
				if (e.getClickCount() == 2) {
					Location selection = selectedLocationList.getSelectedValue();
					if (selection != null) {
						// LOGGER.debug("Removing: " + selection);
						if (selectedLocationModel.contains(selection)) {
							selectedLocationModel.removeElement(selection);
							if (!availableLocationModel.contains(selection)) {
								availableLocationModel.addElement(selection);
							}
							sortLists();
						}
					}
				}
			}
		});

		availableLocationList.addMouseListener(new MouseAdapter() {
			public void mouseClicked(MouseEvent e) {
				if (e.getClickCount() == 2) {
					Location selection = availableLocationList.getSelectedValue();
					if (selection != null) {
						// LOGGER.debug("Adding: " + selection);
						if (!selectedLocationModel.contains(selection)) {
							selectedLocationModel.addElement(selection);
							availableLocationModel.removeElement(selection);
						}
						sortLists();
					}
				}
			}
		});

		// the listeners for the button panel in the middle
		addAllButton.addActionListener(new ActionListener() {
			@Override
			public void actionPerformed(ActionEvent e) {
				moveAll(availableLocationModel, selectedLocationModel);
			}
		});
		addButton.addActionListener(new ActionListener() {
			@Override
			public void actionPerformed(ActionEvent e) {
				addToSelection(availableLocationList.getSelectedValuesList());

			}
		});
		removeButton.addActionListener(new ActionListener() {
			@Override
			public void actionPerformed(ActionEvent e) {
				removeFromSelection(selectedLocationList.getSelectedValuesList());

			}
		});
		removeAllButton.addActionListener(new ActionListener() {
			@Override
			public void actionPerformed(ActionEvent e) {
				moveAll(selectedLocationModel, availableLocationModel);
			}
		});

		// the text header
		grid.add(new QLabel("Verfügbare Räume"));
		grid.skip();
		grid.add(new QLabel("Ausgewählte Räume"));
		grid.nextRow();

		// the available location panel
		JScrollPane availableScrollPane = new JScrollPane(availableLocationList);
		availableScrollPane.setPreferredSize(Gui.getScaledDimension(200, 150));
		grid.add(availableScrollPane).fill(true, true).expand(true, true);

		// the middle button panel
		JPanel buttonPanel = new JPanel();
		GridManager buttonGrid = new GridManager(buttonPanel, 1);
		buttonGrid.add(addAllButton).fill(true, false);
		buttonGrid.nextRow();
		buttonGrid.add(addButton).fill(true, false);
		buttonGrid.nextRow();
		buttonGrid.add(removeButton).fill(true, false);
		buttonGrid.nextRow();
		buttonGrid.add(removeAllButton).fill(true, false);
		buttonGrid.nextRow();
		buttonGrid.finish(true);
		grid.add(buttonPanel).fill(false, false).expand(false, false);

		// the selection location panel
		JScrollPane selectionScrollPane = new JScrollPane(selectedLocationList);
		selectionScrollPane.setPreferredSize(Gui.getScaledDimension(200, 150));
		grid.add(selectionScrollPane).fill(true, true).expand(true, true);
		grid.nextRow();

		// the radio buttons, default is to show the lecture exclusively in the selected locations
		exclusivelyButton.setSelected(true);
		ButtonGroup group = new ButtonGroup();
		group.add(exclusivelyButton);
		group.add(prioritizedButton);
		JPanel radioPanel = new JPanel();
		radioPanel.setLayout(new BoxLayout(radioPanel, BoxLayout.PAGE_AXIS));
		radioPanel.add(exclusivelyButton);
		radioPanel.add(prioritizedButton);
		grid.add(radioPanel, 3);
		grid.finish(true);

		// initialise the data
		init();
	}

	/**
	 * Async fetching of the list of the locations from the server
	 */
	public void init() {
		QuickTimer.scheduleOnce(new Task() {
			List<Location> locsList = null;

			@Override
			public void fire() {
				locsList = MetaDataCache.getLocations();
				Gui.asyncExec(new Runnable() {
					@Override
					public void run() {
						initDone = fillLocationsList(locsList);
						// check if preselection was set before we were done
						// initialising
						if (initDone && preselection != null) {
							setSelectionInternal(preselection);
						}
					}
				});
			}
		});
	}

	/**
	 * Moves all elements from the available to the selected list
	 * 
	 * @param model
	 *            to move from
	 * @param model
	 *            to move to
	 */
	private void moveAll(DefaultListModel<Location> from,
			DefaultListModel<Location> to) {
		for (Enumeration<Location> location = from.elements(); location
				.hasMoreElements();) {
			Location current = location.nextElement();
			to.addElement(current);
		}
		from.clear();
		sortLists();
	}

	/**
	 * Adds the given location to the selection
	 * 
	 * @param location
	 *            to add to selection
	 */
	private void addToSelection(Location location) {
		if (location == null) {
			return;
		}
		List<Location> newLocations = new ArrayList<Location>();
		newLocations.add(location);
		addToSelection(newLocations);
	}

	/**
	 * Adds the given list of locations to the selection
	 * 
	 * @param list
	 *            of locations to add to the selection
	 */
	private void addToSelection(List<Location> locations) {
		if (locations == null)
			return;
		// LOGGER.debug("AddToSelection: " + locations);
		for (Location location : locations) {
			selectedLocationModel.addElement(location);
			availableLocationModel.removeElement(location);
		}
		sortLists();
	}

	/**
	 * Removes the given list of locations from the selections
	 * 
	 * @param locations
	 *            to remove from the selection
	 */
	private void removeFromSelection(List<Location> locations) {
		if (locations == null)
			return;
		// LOGGER.debug("RemoveFromSelection: " + locations);
		for (Location location : locations) {
			selectedLocationModel.removeElement(location);
			availableLocationModel.addElement(location);
		}
		sortLists();
	}

	/**
	 * Helper to sort both lists when changes occur. TODO: doing this via model
	 * change listeners?
	 */
	private void sortLists() {
		// sort the available location list
		List<Location> list = Collections.list(availableLocationModel.elements());
		Collections.sort(list);
		availableLocationModel.clear();
		for (Location loc : list) {
			availableLocationModel.addElement(loc);
		}
		// sort the selected location list
		list = Collections.list(selectedLocationModel.elements());
		Collections.sort(list);
		selectedLocationModel.clear();
		for (Location loc : list) {
			selectedLocationModel.addElement(loc);
		}
	}

	/**
	 * Internal helper to set the selection of the list of location
	 * corresponding the the given list of ids
	 *
	 * @param list of id's to set the selected locations to
	 */
	private void setSelectionInternal(List<Integer> list) {
		if (list == null || list.isEmpty()) {
			LOGGER.error("No list given for preselection!");
			return;
		}
		LOGGER.debug("Setting to: " + preselection);
		moveAll(selectedLocationModel, availableLocationModel);

		for (Integer id : preselection) {
			LOGGER.debug("Searching: " + id);
			Location loc = MetaDataCache.getLocationById(id);
			LOGGER.debug("Found: " + loc);
			if (loc != null) {
				addToSelection(loc);
				LOGGER.debug("Added: " + loc);
			}
		}
	}
}

@SuppressWarnings("serial")
class LocationRenderer extends DefaultListCellRenderer {
	@Override
	public Component getListCellRendererComponent(JList<? extends Object> list,
			Object value, int index, boolean isSelected, boolean cellHasFocus) {
		if (value instanceof Location) {
			return super.getListCellRendererComponent(list,
					((Location) value).getLocationName(), index, isSelected,
					cellHasFocus);
		}
		return super.getListCellRendererComponent(list, value, index,
				isSelected, cellHasFocus);
	}
}