Mercurial > projects > dwt2
diff org.eclipse.core.databinding/src/org/eclipse/core/databinding/observable/list/IObservableList.d @ 78:0a55d2d5a946
Added file for databinding
author | Frank Benoit <benoit@tionex.de> |
---|---|
date | Tue, 14 Apr 2009 11:35:29 +0200 |
parents | |
children | 383ce7bd736b |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/org.eclipse.core.databinding/src/org/eclipse/core/databinding/observable/list/IObservableList.d Tue Apr 14 11:35:29 2009 +0200 @@ -0,0 +1,200 @@ +/******************************************************************************* + * Copyright (c) 2006, 2008 IBM Corporation and others. + * 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: + * IBM Corporation - initial API and implementation + * Brad Reynolds - bug 167204 + * Matthew Hall - bug 208858 + *******************************************************************************/ + +module org.eclipse.core.databinding.observable.list.IObservableList; + +import java.lang.all; + +import java.util.Collection; +import java.util.Iterator; +import java.util.List; +import java.util.ListIterator; + +import org.eclipse.core.databinding.observable.IObservableCollection; + +/** + * A list whose changes can be tracked by list change listeners. + * + * @noextend This interface is not intended to be extended by clients. + * @noimplement This interface is not intended to be implemented by clients. + * Clients should instead subclass one of the framework classes + * that implement this interface. Note that direct implementers of + * this interface outside of the framework will be broken in future + * releases when methods are added to this interface. + * + * @see AbstractObservableList + * @see ObservableList + * + * @since 1.0 + */ +public interface IObservableList : List, IObservableCollection { + + /** + * Adds the given list change listener to the list of list change listeners. + * @param listener + */ + public void addListChangeListener(IListChangeListener listener); + + /** + * Removes the given list change listener from the list of list change listeners. + * Has no effect if the given listener is not registered as a list change listener. + * + * @param listener + */ + public void removeListChangeListener(IListChangeListener listener); + + /** + * @TrackedGetter + */ + public int size(); + + /** + * @TrackedGetter + */ + public bool isEmpty(); + + /** + * @TrackedGetter + */ + public bool contains(Object o); + + /** + * @TrackedGetter + */ + public Iterator iterator(); + + /** + * @TrackedGetter + */ + public Object[] toArray(); + + /** + * @TrackedGetter + */ + public Object[] toArray(Object a[]); + + /** + * + */ + public bool add(Object o); + + /** + * + */ + public bool remove(Object o); + + /** + * @TrackedGetter + */ + public bool containsAll(Collection c); + + /** + * + */ + public bool addAll(Collection c); + + /** + * + */ + public bool addAll(int index, Collection c); + + /** + * + */ + public bool removeAll(Collection c); + + /** + * + */ + public bool retainAll(Collection c); + + /** + * @TrackedGetter + */ + public bool opEquals(Object o); + + /** + * @TrackedGetter + */ + public int hashCode(); + + /** + * @TrackedGetter + */ + public Object get(int index); + + /** + * + */ + public Object set(int index, Object element); + + /** + * Moves the element located at <code>oldIndex</code> to + * <code>newIndex</code>. This method is equivalent to calling + * <code>add(newIndex, remove(oldIndex))</code>. + * <p> + * Implementors should deliver list change notification for the remove and + * add operations in the same ListChangeEvent, as this allows + * {@link ListDiff#acceptcast(ListDiffVisitor)} to recognize the operation as a + * move. + * + * @param oldIndex + * the element's position before the move. Must be within the + * range <code>0 <= oldIndex < size()</code>. + * @param newIndex + * the element's position after the move. Must be within the + * range <code>0 <= newIndex < size()</code>. + * @return the element that was moved. + * @throws IndexOutOfBoundsException + * if either argument is out of range (<code>0 <= index < size()</code>). + * @see ListDiffVisitor#handleMove(int, int, Object) + * @see ListDiff#acceptcast(ListDiffVisitor) + * @since 1.1 + */ + public Object move(int oldIndex, int newIndex); + + /** + * + */ + public Object remove(int index); + + /** + * @TrackedGetter + */ + public int indexOf(Object o); + + /** + * @TrackedGetter + */ + public int lastIndexOf(Object o); + + /** + * @TrackedGetter + */ + public ListIterator listIterator(); + + /** + * @TrackedGetter + */ + public ListIterator listIterator(int index); + + /** + * @TrackedGetter + */ + public List subList(int fromIndex, int toIndex); + + /** + * @return the type of the elements or <code>null</code> if untyped + */ + Object getElementType(); +}