r/org.eclipse.statet.ide.ui/srcECommons/org/eclipse/statet/ecommons/ui/dialogs/groups/StructuredSelectionOptionsGroup.java

/*=============================================================================#
 # Copyright (c) 2005, 2019 Stephan Wahlbrink and others.
 # 
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License 2.0 which is available at
 # https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 # which is available at https://www.apache.org/licenses/LICENSE-2.0.
 # 
 # SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 # 
 # Contributors:
 #     Stephan Wahlbrink <sw@wahlbrink.eu> - initial API and implementation
 #=============================================================================*/

package org.eclipse.statet.ecommons.ui.dialogs.groups;

import org.eclipse.jface.viewers.DoubleClickEvent;
import org.eclipse.jface.viewers.IContentProvider;
import org.eclipse.jface.viewers.IDoubleClickListener;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.IStructuredContentProvider;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.viewers.StructuredViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.swt.events.KeyAdapter;
import org.eclipse.swt.events.KeyEvent;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;


public abstract class StructuredSelectionOptionsGroup<SelectionT extends StructuredViewer, ItemT extends Object> 
		extends SelectionOptionsGroup<ItemT> {

	
	private class ItemContentProvider implements IStructuredContentProvider {

		@Override
		public void dispose() {
		}

		@Override
		public void inputChanged(final Viewer viewer, final Object oldInput, final Object newInput) {
		}
		
		@Override
		public Object[] getElements(final Object inputElement) {
			return getListModel().toArray();
		}
	}

	
	private SelectionT fSelectionViewer;
	
	
	public StructuredSelectionOptionsGroup(final boolean grabSelectionHorizontal, final boolean grabVertical) {
		super(grabSelectionHorizontal, grabVertical);
	}
	
	@Override
	protected Control createSelectionControl(final Composite parent) {
		this.fSelectionViewer = createSelectionViewer(parent);
		this.fSelectionViewer.setContentProvider(createContentProvider());
		this.fSelectionViewer.addSelectionChangedListener(createSelectionChangeListener());
		this.fSelectionViewer.addDoubleClickListener(createDoubleClickListener());
		this.fSelectionViewer.getControl().addKeyListener(new KeyAdapter() {
			@Override
			public void keyPressed(final KeyEvent e) {
				handleKeyPressed(e);
			}
		});
		return this.fSelectionViewer.getControl();
	}

	protected abstract SelectionT createSelectionViewer(Composite parent);
	
	protected IContentProvider createContentProvider() {
		return new ItemContentProvider();
	}
	
	protected ISelectionChangedListener createSelectionChangeListener() {
		return new ISelectionChangedListener() {
			@Override
			public void selectionChanged(final SelectionChangedEvent event) {
				final IStructuredSelection selection = (IStructuredSelection) event.getSelection();
				handleSelection(getSingleItem(selection), selection);
			}
		};
	}
	
	protected IDoubleClickListener createDoubleClickListener() {
		return new IDoubleClickListener() {
			@Override
			public void doubleClick(final DoubleClickEvent event) {
				final IStructuredSelection selection = (IStructuredSelection) event.getSelection();
				handleDoubleClick(getSingleItem(selection), selection);
			}
		};
	}
	
	public SelectionT getStructuredViewer() {
		return this.fSelectionViewer;
	}

	@Override
	public void initFields() {
		super.initFields();
		this.fSelectionViewer.setInput(getListModel());
		this.fSelectionViewer.refresh();
	}

	public void refresh() {
		getStructuredViewer().refresh();
		reselect();
	}

	public void reselect() {
		final IStructuredSelection selection = getSelectedItems();
		handleSelection(getSingleItem(selection), selection);
	}
	
	/**
	 * Selection-change in List
	 * <p>
	 * Default-Implementierung macht nichts.
	 */
	protected void handleSelection(final ItemT item, final IStructuredSelection rawSelection) {
	}

	/**
	 * Double-click on table item.
	 * <p>
	 * Default Implementierung macht nichts.
	 * @param item
	 */
	protected void handleDoubleClick(final ItemT item, final IStructuredSelection rawSelection) {
	}

	/**
	 * Handles key events in the table viewer.
	 * <p>
	 * Standard-Implementierung macht nichts.
	 */
	protected void handleKeyPressed(final KeyEvent event) {
	}

	
	public IStructuredSelection getSelectedItems() {
		return (IStructuredSelection) this.fSelectionViewer.getSelection();
	}
	
	public ItemT getSingleItem(final IStructuredSelection selection) {
		if (selection.size() == 1) {
			return (ItemT) selection.getFirstElement(); 
		}
		return null;
	}
	
}