diff options
Diffstat (limited to 'jpa/plugins/org.eclipse.jpt.ui/src/org/eclipse/jpt/ui/internal/swt/ListBoxModelAdapter.java')
| -rw-r--r-- | jpa/plugins/org.eclipse.jpt.ui/src/org/eclipse/jpt/ui/internal/swt/ListBoxModelAdapter.java | 627 |
1 files changed, 0 insertions, 627 deletions
diff --git a/jpa/plugins/org.eclipse.jpt.ui/src/org/eclipse/jpt/ui/internal/swt/ListBoxModelAdapter.java b/jpa/plugins/org.eclipse.jpt.ui/src/org/eclipse/jpt/ui/internal/swt/ListBoxModelAdapter.java deleted file mode 100644 index 08f1a21839..0000000000 --- a/jpa/plugins/org.eclipse.jpt.ui/src/org/eclipse/jpt/ui/internal/swt/ListBoxModelAdapter.java +++ /dev/null @@ -1,627 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2007, 2008 Oracle. All rights reserved. - * This program and the accompanying materials are made available under the - * terms of the Eclipse Public License v1.0, which accompanies this distribution - * and is available at http://www.eclipse.org/legal/epl-v10.html. - * - * Contributors: - * Oracle - initial API and implementation - ******************************************************************************/ -package org.eclipse.jpt.ui.internal.swt; - -import java.util.ArrayList; -import java.util.Collection; -import java.util.Collections; -import java.util.EventObject; -import java.util.Iterator; -import java.util.ListIterator; -import org.eclipse.jpt.ui.internal.listeners.SWTCollectionChangeListenerWrapper; -import org.eclipse.jpt.ui.internal.listeners.SWTListChangeListenerWrapper; -import org.eclipse.jpt.utility.internal.CollectionTools; -import org.eclipse.jpt.utility.internal.StringConverter; -import org.eclipse.jpt.utility.internal.StringTools; -import org.eclipse.jpt.utility.internal.model.value.PropertyCollectionValueModelAdapter; -import org.eclipse.jpt.utility.model.event.CollectionChangeEvent; -import org.eclipse.jpt.utility.model.event.ListChangeEvent; -import org.eclipse.jpt.utility.model.listener.CollectionChangeListener; -import org.eclipse.jpt.utility.model.listener.ListChangeListener; -import org.eclipse.jpt.utility.model.value.CollectionValueModel; -import org.eclipse.jpt.utility.model.value.ListValueModel; -import org.eclipse.jpt.utility.model.value.PropertyValueModel; -import org.eclipse.swt.events.DisposeEvent; -import org.eclipse.swt.events.DisposeListener; -import org.eclipse.swt.events.SelectionEvent; -import org.eclipse.swt.events.SelectionListener; -import org.eclipse.swt.widgets.List; - -/** - * This adapter provides a more object-oriented interface to the items and - * selected items in a list box. - * 'listHolder' contains the items in the list box. - * 'selectedItemsHolder' contains the items in 'listHolder' that are selected - * in the list box. - */ -@SuppressWarnings("nls") -public class ListBoxModelAdapter<E> { - - // ********** model ********** - /** - * A value model on the underlying model list. - */ - protected final ListValueModel<E> listHolder; - - /** - * A listener that allows us to synchronize the list box's contents with - * the model list. - */ - protected final ListChangeListener listChangeListener; - - /** - * A value model on the underlying model selections. - */ - protected final CollectionValueModel<E> selectedItemsHolder; - - /** - * A listener that allows us to synchronize the list box's selection with - * the model selections. - */ - protected final CollectionChangeListener selectedItemsChangeListener; - - /** - * A converter that converts items in the model list - * to strings that can be put in the list box. - */ - protected StringConverter<E> stringConverter; - - // ********** UI ********** - /** - * The list box we keep synchronized with the model list. - */ - protected final List listBox; - - /** - * A listener that allows us to synchronize our selection list holder - * with the list box's selection. - */ - protected final SelectionListener listBoxSelectionListener; - - /** - * Clients that are interested in selection change events. - */ - protected SelectionChangeListener<E>[] selectionChangeListeners; - - /** - * Clients that are interested in double click events. - */ - protected DoubleClickListener<E>[] doubleClickListeners; - - /** - * A listener that allows us to stop listening to stuff when the list box - * is disposed. - */ - protected final DisposeListener listBoxDisposeListener; - - - // ********** static methods ********** - - /** - * Adapt the specified model list and selections to the specified list box. - * Use the default string converter to convert the model items to strings - * to be displayed in the list box, which calls #toString() on the - * items in the model list. - */ - public static <T> ListBoxModelAdapter<T> adapt( - ListValueModel<T> listHolder, - CollectionValueModel<T> selectedItemsHolder, - List listBox) - { - return adapt(listHolder, selectedItemsHolder, listBox, StringConverter.Default.<T>instance()); - } - - /** - * Adapt the specified model list and selections to the specified list box. - * Use the specified string converter to convert the model items to strings - * to be displayed in the list box. - */ - public static <T> ListBoxModelAdapter<T> adapt( - ListValueModel<T> listHolder, - CollectionValueModel<T> selectedItemsHolder, - List listBox, - StringConverter<T> stringConverter) - { - return new ListBoxModelAdapter<T>(listHolder, selectedItemsHolder, listBox, stringConverter); - } - - /** - * Adapt the specified model list and selection to the specified list box. - * Use the default string converter to convert the model items to strings - * to be displayed in the list box, which calls #toString() on the - * items in the model list. - */ - public static <T> ListBoxModelAdapter<T> adapt( - ListValueModel<T> listHolder, - PropertyValueModel<T> selectedItemHolder, - List listBox) - { - return adapt(listHolder, selectedItemHolder, listBox, StringConverter.Default.<T>instance()); - } - - /** - * Adapt the specified model list and selection to the specified list box. - * Use the specified string converter to convert the model items to strings - * to be displayed in the list box. - */ - public static <T> ListBoxModelAdapter<T> adapt( - ListValueModel<T> listHolder, - PropertyValueModel<T> selectedItemHolder, - List listBox, - StringConverter<T> stringConverter) - { - return new ListBoxModelAdapter<T>(listHolder, new PropertyCollectionValueModelAdapter<T>(selectedItemHolder), listBox, stringConverter); - } - - - // ********** constructors ********** - - /** - * Constructor - the list holder, selections holder, list box, and - * string converter are required. - */ - protected ListBoxModelAdapter( - ListValueModel<E> listHolder, - CollectionValueModel<E> selectedItemsHolder, - List listBox, - StringConverter<E> stringConverter) - { - super(); - if ((listHolder == null) || (selectedItemsHolder == null) || (listBox == null) || (stringConverter == null)) { - throw new NullPointerException(); - } - this.listHolder = listHolder; - this.selectedItemsHolder = selectedItemsHolder; - this.listBox = listBox; - this.stringConverter = stringConverter; - - this.listChangeListener = this.buildListChangeListener(); - this.listHolder.addListChangeListener(ListValueModel.LIST_VALUES, this.listChangeListener); - - this.selectedItemsChangeListener = this.buildSelectedItemsChangeListener(); - this.selectedItemsHolder.addCollectionChangeListener(CollectionValueModel.VALUES, this.selectedItemsChangeListener); - - this.listBoxSelectionListener = this.buildListBoxSelectionListener(); - this.listBox.addSelectionListener(this.listBoxSelectionListener); - - this.selectionChangeListeners = this.buildSelectionChangeListeners(); - this.doubleClickListeners = this.buildDoubleClickListeners(); - - this.listBoxDisposeListener = this.buildListBoxDisposeListener(); - this.listBox.addDisposeListener(this.listBoxDisposeListener); - - this.synchronizeListBox(); - } - - - // ********** initialization ********** - - protected ListChangeListener buildListChangeListener() { - return new SWTListChangeListenerWrapper(this.buildListChangeListener_()); - } - - protected ListChangeListener buildListChangeListener_() { - return new ListChangeListener() { - public void itemsAdded(ListChangeEvent event) { - ListBoxModelAdapter.this.listItemsAdded(event); - } - public void itemsRemoved(ListChangeEvent event) { - ListBoxModelAdapter.this.listItemsRemoved(event); - } - public void itemsMoved(ListChangeEvent event) { - ListBoxModelAdapter.this.listItemsMoved(event); - } - public void itemsReplaced(ListChangeEvent event) { - ListBoxModelAdapter.this.listItemsReplaced(event); - } - public void listCleared(ListChangeEvent event) { - ListBoxModelAdapter.this.listCleared(event); - } - public void listChanged(ListChangeEvent event) { - ListBoxModelAdapter.this.listChanged(event); - } - @Override - public String toString() { - return "list listener"; - } - }; - } - - protected CollectionChangeListener buildSelectedItemsChangeListener() { - return new SWTCollectionChangeListenerWrapper(this.buildSelectedItemsChangeListener_()); - } - - protected CollectionChangeListener buildSelectedItemsChangeListener_() { - return new CollectionChangeListener() { - public void itemsAdded(CollectionChangeEvent event) { - ListBoxModelAdapter.this.selectedItemsAdded(event); - } - public void itemsRemoved(CollectionChangeEvent event) { - ListBoxModelAdapter.this.selectedItemsRemoved(event); - } - public void collectionCleared(CollectionChangeEvent event) { - ListBoxModelAdapter.this.selectedItemsCleared(event); - } - public void collectionChanged(CollectionChangeEvent event) { - ListBoxModelAdapter.this.selectedItemsChanged(event); - } - @Override - public String toString() { - return "selected items listener"; - } - }; - } - - protected SelectionListener buildListBoxSelectionListener() { - return new SelectionListener() { - public void widgetSelected(SelectionEvent event) { - ListBoxModelAdapter.this.listBoxSelectionChanged(event); - } - public void widgetDefaultSelected(SelectionEvent event) { - ListBoxModelAdapter.this.listBoxDoubleClicked(event); - } - @Override - public String toString() { - return "list box selection listener"; - } - }; - } - - @SuppressWarnings("unchecked") - protected DoubleClickListener<E>[] buildDoubleClickListeners() { - return new DoubleClickListener[0]; - } - - @SuppressWarnings("unchecked") - protected SelectionChangeListener<E>[] buildSelectionChangeListeners() { - return new SelectionChangeListener[0]; - } - - protected DisposeListener buildListBoxDisposeListener() { - return new DisposeListener() { - public void widgetDisposed(DisposeEvent event) { - ListBoxModelAdapter.this.listBoxDisposed(event); - } - @Override - public String toString() { - return "list box dispose listener"; - } - }; - } - - protected void synchronizeListBox() { - this.synchronizeListBoxItems(); - this.synchronizeListBoxSelection(); - } - - - // ********** string converter ********** - - public void setStringConverter(StringConverter<E> stringConverter) { - if (stringConverter == null) { - throw new NullPointerException(); - } - this.stringConverter = stringConverter; - this.synchronizeListBox(); - } - - - // ********** list ********** - - /** - * Use the string converter to convert the specified item to a - * string that can be added to the list box. - */ - protected String convert(E item) { - return this.stringConverter.convertToString(item); - } - - /** - * Brute force synchronization of list box with the model list. - */ - protected void synchronizeListBoxItems() { - if (this.listBox.isDisposed()) { - return; - } - int len = this.listHolder.size(); - String[] items = new String[len]; - for (int i = 0; i < len; i++) { - items[i] = this.convert(this.listHolder.get(i)); - } - this.listBox.setItems(items); - } - - /** - * The model has changed - synchronize the list box. - */ - protected void listItemsAdded(ListChangeEvent event) { - if (this.listBox.isDisposed()) { - return; - } - int i = event.getIndex(); - for (ListIterator<E> stream = this.items(event); stream.hasNext(); ) { - this.listBox.add(this.convert(stream.next()), i++); - } - } - - /** - * The model has changed - synchronize the list box. - */ - protected void listItemsRemoved(ListChangeEvent event) { - if (this.listBox.isDisposed()) { - return; - } - this.listBox.remove(event.getIndex(), event.getIndex() + event.itemsSize() - 1); - } - - /** - * The model has changed - synchronize the list box. - */ - protected void listItemsMoved(ListChangeEvent event) { - if (this.listBox.isDisposed()) { - return; - } - int target = event.getTargetIndex(); - int source = event.getSourceIndex(); - int len = event.getMoveLength(); - int loStart = Math.min(target, source); - int hiStart = Math.max(target, source); - // make a copy of the affected items... - String[] subArray = CollectionTools.subArray(this.listBox.getItems(), loStart, hiStart + len - loStart); - // ...move them around... - subArray = CollectionTools.move(subArray, target - loStart, source - loStart, len); - // ...and then put them back - for (int i = 0; i < subArray.length; i++) { - this.listBox.setItem(loStart + i, subArray[i]); - } - } - - /** - * The model has changed - synchronize the list box. - */ - protected void listItemsReplaced(ListChangeEvent event) { - if (this.listBox.isDisposed()) { - return; - } - int i = event.getIndex(); - for (ListIterator<E> stream = this.items(event); stream.hasNext(); ) { - this.listBox.setItem(i++, this.convert(stream.next())); - } - } - - /** - * The model has changed - synchronize the list box. - */ - protected void listCleared(ListChangeEvent event) { - if (this.listBox.isDisposed()) { - return; - } - this.listBox.removeAll(); - } - - /** - * The model has changed - synchronize the list box. - */ - protected void listChanged(ListChangeEvent event) { - this.synchronizeListBoxItems(); - } - - // minimized unchecked code - @SuppressWarnings("unchecked") - protected ListIterator<E> items(ListChangeEvent event) { - return ((ListIterator<E>) event.items()); - } - - - // ********** selected items ********** - - protected int indexOf(E item) { - int len = this.listHolder.size(); - for (int i = 0; i < len; i++) { - if (this.listHolder.get(i) == item) { - return i; - } - } - return -1; - } - - protected void synchronizeListBoxSelection() { - if (this.listBox.isDisposed()) { - return; - } - int[] indices = new int[this.selectedItemsHolder.size()]; - int i = 0; - for (Iterator<E> stream = this.selectedItemsHolder.iterator(); stream.hasNext(); ) { - indices[i++] = this.indexOf(stream.next()); - } - this.listBox.deselectAll(); - this.listBox.select(indices); - } - - protected void selectedItemsAdded(CollectionChangeEvent event) { - if (this.listBox.isDisposed()) { - return; - } - int[] indices = new int[event.itemsSize()]; - int i = 0; - for (Iterator<E> stream = this.items(event); stream.hasNext(); ) { - indices[i++] = this.indexOf(stream.next()); - } - this.listBox.select(indices); - } - - protected void selectedItemsRemoved(CollectionChangeEvent event) { - if (this.listBox.isDisposed()) { - return; - } - int[] indices = new int[event.itemsSize()]; - int i = 0; - for (Iterator<E> stream = this.items(event); stream.hasNext(); ) { - indices[i++] = this.indexOf(stream.next()); - } - this.listBox.deselect(indices); - } - - protected void selectedItemsCleared(CollectionChangeEvent event) { - if (this.listBox.isDisposed()) { - return; - } - this.listBox.deselectAll(); - } - - protected void selectedItemsChanged(CollectionChangeEvent event) { - this.synchronizeListBoxSelection(); - } - - // minimized unchecked code - @SuppressWarnings("unchecked") - protected Iterator<E> items(CollectionChangeEvent event) { - return ((Iterator<E>) event.items()); - } - - - // ********** list box events ********** - - protected void listBoxSelectionChanged(SelectionEvent event) { - if (this.selectionChangeListeners.length > 0) { - @SuppressWarnings("unchecked") - SelectionChangeEvent<E> scEvent = new SelectionChangeEvent(this, this.selectedItems()); - for (SelectionChangeListener<E> selectionChangeListener : this.selectionChangeListeners) { - selectionChangeListener.selectionChanged(scEvent); - } - } - } - - protected Collection<E> selectedItems() { - if (this.listBox.isDisposed()) { - return Collections.emptySet(); - } - @SuppressWarnings("unchecked") - ArrayList<E> selectedItems = new ArrayList(this.listBox.getSelectionCount()); - for (int selectionIndex : this.listBox.getSelectionIndices()) { - selectedItems.add(this.listHolder.get(selectionIndex)); - } - return selectedItems; - } - - protected void listBoxDoubleClicked(SelectionEvent event) { - if (this.listBox.isDisposed()) { - return; - } - if (this.doubleClickListeners.length > 0) { - // there should be only a single item selected during a double-click(?) - E selection = this.listHolder.get(this.listBox.getSelectionIndex()); - @SuppressWarnings("unchecked") - DoubleClickEvent<E> dcEvent = new DoubleClickEvent(this, selection); - for (DoubleClickListener<E> doubleClickListener : this.doubleClickListeners) { - doubleClickListener.doubleClick(dcEvent); - } - } - } - - - // ********** dispose ********** - - protected void listBoxDisposed(DisposeEvent event) { - // the list box is not yet "disposed" when we receive this event - // so we can still remove our listeners - this.listBox.removeDisposeListener(this.listBoxDisposeListener); - this.listBox.removeSelectionListener(this.listBoxSelectionListener); - this.selectedItemsHolder.removeCollectionChangeListener(CollectionValueModel.VALUES, this.selectedItemsChangeListener); - this.listHolder.removeListChangeListener(ListValueModel.LIST_VALUES, this.listChangeListener); - } - - - // ********** standard methods ********** - - @Override - public String toString() { - return StringTools.buildToStringFor(this, this.listHolder); - } - - - // ********** double click support ********** - - public void addDoubleClickListener(DoubleClickListener<E> listener) { - this.doubleClickListeners = CollectionTools.add(this.doubleClickListeners, listener); - } - - public void removeDoubleClickListener(DoubleClickListener<E> listener) { - this.doubleClickListeners = CollectionTools.remove(this.doubleClickListeners, listener); - } - - public interface DoubleClickListener<E> { - void doubleClick(DoubleClickEvent<E> event); - } - - public static class DoubleClickEvent<E> extends EventObject { - private final E selection; - private static final long serialVersionUID = 1L; - - protected DoubleClickEvent(ListBoxModelAdapter<E> source, E selection) { - super(source); - if (selection == null) { - throw new NullPointerException(); - } - this.selection = selection; - } - - @Override - @SuppressWarnings("unchecked") - public ListBoxModelAdapter<E> getSource() { - return (ListBoxModelAdapter<E>) super.getSource(); - } - - public E selection() { - return this.selection; - } - - } - - - // ********** selection support ********** - - public void addSelectionChangeListener(SelectionChangeListener<E> listener) { - this.selectionChangeListeners = CollectionTools.add(this.selectionChangeListeners, listener); - } - - public void removeSelectionChangeListener(SelectionChangeListener<E> listener) { - this.selectionChangeListeners = CollectionTools.remove(this.selectionChangeListeners, listener); - } - - public interface SelectionChangeListener<E> { - void selectionChanged(SelectionChangeEvent<E> event); - } - - public static class SelectionChangeEvent<E> extends EventObject { - private final Collection<E> selection; - private static final long serialVersionUID = 1L; - - protected SelectionChangeEvent(ListBoxModelAdapter<E> source, Collection<E> selection) { - super(source); - if (selection == null) { - throw new NullPointerException(); - } - this.selection = selection; - } - - @Override - @SuppressWarnings("unchecked") - public ListBoxModelAdapter<E> getSource() { - return (ListBoxModelAdapter<E>) super.getSource(); - } - - public Iterator<E> selection() { - return this.selection.iterator(); - } - - } - -} |