diff options
Diffstat (limited to 'org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ITreeModelContentProviderTarget.java')
| -rw-r--r-- | org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ITreeModelContentProviderTarget.java | 232 |
1 files changed, 232 insertions, 0 deletions
diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ITreeModelContentProviderTarget.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ITreeModelContentProviderTarget.java new file mode 100644 index 000000000..701ebca0d --- /dev/null +++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ITreeModelContentProviderTarget.java @@ -0,0 +1,232 @@ +/******************************************************************************* + * Copyright (c) 2009 Wind River Systems 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: + * Wind River Systems - initial API and implementation + *******************************************************************************/ +package org.eclipse.debug.internal.ui.viewers.model; + +import org.eclipse.jface.viewers.ISelection; +import org.eclipse.jface.viewers.TreePath; +import org.eclipse.jface.viewers.ViewerFilter; + +/** + * This interface must be implemented by the viewer which uses the + * {@link TreeModelContentProvider} content provider. It allows the content + * provider to update the viewer with information retrieved from the + * content, proxy, memento, and other element-based providers. + * + * @since 3.5 + */ +public interface ITreeModelContentProviderTarget extends ITreeModelViewer { + + /** + * Returns this viewer's filters. + * + * @return an array of viewer filters + * @see StructuredViewer#setFilters(ViewerFilter[]) + */ + public ViewerFilter[] getFilters(); + + /** + * Reveals the given element in the viewer. + * @param path Path to the element's parent. + * @param index Index of the element to be revealed. + */ + public void reveal(TreePath path, int index); + + /** + * Triggers an update of the given element's state. If multiple instances + * of the given element are found in the tree, they will all be updated. + * + * @param element Element to update. + */ + public void update(Object element); + + /** + * Triggers an update of the given element and its children. If + * multiple instances of the given element are found in the tree, + * they will all be updated. + * + * @param element Element to update. + */ + public void refresh(Object element); + + /** + * Triggers a full update of all the elements in the tree. + * + * @param element Element to update. + */ + public void refresh(); + + /** + * Sets the given object to be the element at the given index of the given parent. + * <p> + * This method should only be called by the viewer framework. + * </p> + * + * @param parentOrTreePath Parent object, or a tree path of the parent element. + * @param index Index at which to set the new element. + * @param element Element object. + */ + public void replace(Object parentOrTreePath, final int index, Object element); + + /** + * Set the number of children of the given element or tree path. To set the + * number of children of the invisible root of the tree, you can pass the + * input object or an empty tree path. + * <p> + * This method should only be called by the viewer framework. + * </p> + * + * @param elementOrTreePath The element, or tree path. + * @param count + */ + public void setChildCount(final Object elementOrTreePath, final int count); + + /** + * Inform the viewer about whether the given element or tree path has + * children. Avoid calling this method if the number of children has + * already been set. + * <p> + * This method should only be called by the viewer framework. + * </p> + * + * @param elementOrTreePath + * the element, or tree path + * @param hasChildren + */ + public void setHasChildren(final Object elementOrTreePath, final boolean hasChildren); + + /** + * Performs auto expand on an element at the specified path if the auto expand + * level dictates the element should be expanded. + * <p> + * This method should only be called by the viewer framework. + * </p> + * + * @param elementPath tree path to element to consider for expansion + */ + public void autoExpand(TreePath elementPath); + + /** + * Sets whether the node corresponding to the given element or tree path is + * expanded or collapsed. + * <p> + * This method should only be called by the viewer framework. + * </p> + * + * @param elementOrTreePath + * the element, or the tree path to the element + * @param expanded + * <code>true</code> if the node is expanded, and + * <code>false</code> if collapsed + */ + public void setExpandedState(Object elementOrTreePath, boolean expanded); + + /** + * Expands all ancestors of the given element or tree path so that the given + * element becomes visible in this viewer's tree control, and then expands + * the subtree rooted at the given element to the given level. + * <p> + * This method should only be called by the viewer framework. + * </p> + * + * @param elementOrTreePath + * the element + * @param level + * non-negative level, or <code>ALL_LEVELS</code> to expand all + * levels of the tree + */ + public void expandToLevel(Object elementOrTreePath, int level); + + + + /** + * Removes the given element from the viewer. The selection is updated if + * necessary. + * <p> + * This method should only be called by the viewer framework. + * </p> + * + * @param elementsOrTreePaths + * the element, or the tree path to the element + */ + public void remove(Object elementOrTreePath); + + /** + * Removes the element at the specified index of the parent. The selection is updated if required. + * <p> + * This method should only be called by the viewer framework. + * </p> + * + * @param parentOrTreePath the parent element, the input element, or a tree path to the parent element + * @param index child index + */ + public void remove(Object parentOrTreePath, final int index); + + /** + * Inserts the given element as a new child element of the given parent + * element at the given position. If this viewer has a sorter, the position + * is ignored and the element is inserted at the correct position in the + * sort order. + * <p> + * This method should only be called by the viewer framework. + * </p> + * + * @param parentElementOrTreePath + * the parent element, or the tree path to the parent + * @param element + * the element + * @param position + * a 0-based position relative to the model, or -1 to indicate + * the last position + */ + public void insert(Object parentOrTreePath, Object element, int position); + + /** + * Returns whether the candidate selection should override the current + * selection. + */ + public boolean overrideSelection(ISelection current, ISelection candidate); + + /** + * Returns whether the node corresponding to the given element or tree path + * is expanded or collapsed. + * + * @param elementOrTreePath + * the element + * @return <code>true</code> if the node is expanded, and + * <code>false</code> if collapsed + */ + public boolean getExpandedState(Object elementOrTreePath); + + /** + * Returns the child count of the element at the given path. + */ + public int getChildCount(TreePath path); + + /** + * Returns the element which is a child of the element at the + * given path, with the given index. + */ + public Object getChildElement(TreePath path, int index); + + /** + * Returns the tree path of the element that is at the top of the + * viewer. + */ + public TreePath getTopElementPath(); + + /** + * Finds the index of the given element with a parent of given path. + * + * @return The element's index, or -1 if not found. + */ + public int findElementIndex(TreePath parentPath, Object element); + +} |