Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ITreeModelContentProvider.java')
-rw-r--r--org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ITreeModelContentProvider.java112
1 files changed, 56 insertions, 56 deletions
diff --git a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ITreeModelContentProvider.java b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ITreeModelContentProvider.java
index 4c995ec2a..cf2d9bcf2 100644
--- a/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ITreeModelContentProvider.java
+++ b/org.eclipse.debug.ui/ui/org/eclipse/debug/internal/ui/viewers/model/ITreeModelContentProvider.java
@@ -4,7 +4,7 @@
* 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
*******************************************************************************/
@@ -21,65 +21,65 @@ import org.eclipse.jface.viewers.ILazyTreePathContentProvider;
import org.eclipse.jface.viewers.TreePath;
import org.eclipse.jface.viewers.Viewer;
-/**
+/**
* {@link TreeModelViewer} content provider interface.
- *
+ *
* @since 3.5
*/
public interface ITreeModelContentProvider extends ILazyTreePathContentProvider {
/**
* Bit-mask which allows all possible model delta flags.
- *
+ *
* @since 3.6
* @see #setModelDeltaMask(int)
*/
- public static final int ALL_MODEL_DELTA_FLAGS = ~0;
+ public static final int ALL_MODEL_DELTA_FLAGS = ~0;
/**
- * Bit-mask which allows only flags which control selection and expansion.
- *
+ * Bit-mask which allows only flags which control selection and expansion.
+ *
* @since 3.6
* @see #setModelDeltaMask(int)
*/
- public static final int CONTROL_MODEL_DELTA_FLAGS =
+ public static final int CONTROL_MODEL_DELTA_FLAGS =
IModelDelta.EXPAND | IModelDelta.COLLAPSE | IModelDelta.SELECT | IModelDelta.REVEAL | IModelDelta.FORCE;
/**
* Bit-mask which allows only flags which update viewer's information
* about the model.
- *
+ *
* @since 3.6
* @see #setModelDeltaMask(int)
*/
- public static final int UPDATE_MODEL_DELTA_FLAGS =
+ public static final int UPDATE_MODEL_DELTA_FLAGS =
IModelDelta.ADDED | IModelDelta.CONTENT | IModelDelta.INSERTED | IModelDelta.INSTALL | IModelDelta.REMOVED |
IModelDelta.REPLACED | IModelDelta.STATE | IModelDelta.UNINSTALL;
/**
* Translates and returns the given child index from the viewer coordinate
* space to the model coordinate space.
- *
+ *
* @param parentPath path to parent element
* @param index index of child element in viewer (filtered) space
* @return index of child element in model (raw) space
*/
public int viewToModelIndex(TreePath parentPath, int index);
-
+
/**
* Translates and returns the given child count from the viewer coordinate
* space to the model coordinate space.
- *
+ *
* @param parentPath path to parent element
* @param count number of child elements in viewer (filtered) space
* @return number of child elements in model (raw) space
*/
public int viewToModelCount(TreePath parentPath, int count);
-
+
/**
* Translates and returns the given child index from the model coordinate
* space to the viewer coordinate space.
- *
+ *
* @param parentPath path to parent element
* @param index index of child element in model (raw) space
* @return index of child element in viewer (filtered) space or -1 if filtered
@@ -89,31 +89,31 @@ public interface ITreeModelContentProvider extends ILazyTreePathContentProvider
/**
* Returns whether the children of given element should be filtered.
* <p>This method is used to determine whether any of the registered filters
- * that extend {@link TreeModelViewerFilter} are applicable to the given
- * element. If so, then children of given element should be filtered
- * prior to populating them in the viewer.
- *
+ * that extend {@link TreeModelViewerFilter} are applicable to the given
+ * element. If so, then children of given element should be filtered
+ * prior to populating them in the viewer.
+ *
* @param parentElement
- * the parent element
- * @return whether there are any {@link TreeModelViewerFilter} filters
+ * the parent element
+ * @return whether there are any {@link TreeModelViewerFilter} filters
* applicable to given parent
*/
- public boolean areTreeModelViewerFiltersApplicable(Object parentElement);
-
+ public boolean areTreeModelViewerFiltersApplicable(Object parentElement);
+
/**
* Returns whether the given element is filtered.
- *
+ *
* @param parentElementOrTreePath
* the parent element or path
* @param element
* the child element
* @return whether to filter the element
*/
- public boolean shouldFilter(Object parentElementOrTreePath, Object element);
+ public boolean shouldFilter(Object parentElementOrTreePath, Object element);
/**
* Notification the given element is being unmapped.
- *
+ *
* @param path Path to unmap
*/
public void unmapPath(TreePath path);
@@ -122,27 +122,27 @@ public interface ITreeModelContentProvider extends ILazyTreePathContentProvider
* Sets the bit mask which will be used to filter the {@link IModelDelta}
* coming from the model. Any delta flags which are hidden by the mask
* will be ignored.
- *
+ *
* @param mask for <code>IModelDelta</code> flags
- *
+ *
* @since 3.6
*/
public void setModelDeltaMask(int mask);
-
+
/**
* Returns the current model delta mask.
- *
+ *
* @return bit mask used to filter model delta events.
- *
+ *
* @see #setModelDeltaMask(int)
* @since 3.6
*/
public int getModelDeltaMask();
-
+
/**
* Translates and returns the given child count from the model coordinate
* space to the viewer coordinate space.
- *
+ *
* @param parentPath path to parent element
* @param count child count element in model (raw) space
* @return child count in viewer (filtered) space
@@ -154,27 +154,27 @@ public interface ITreeModelContentProvider extends ILazyTreePathContentProvider
* @param listener Listener to add
*/
public void addViewerUpdateListener(IViewerUpdateListener listener);
-
+
/**
* Removes the specified listener from update notifications.
* @param listener Listener to remove
*/
public void removeViewerUpdateListener(IViewerUpdateListener listener);
-
+
/**
* Registers the given listener for model delta notification.
* This listener is called immediately after the viewer processes
- * the delta.
+ * the delta.
* @param listener Listener to add
*/
public void addModelChangedListener(IModelChangedListener listener);
-
+
/**
* Removes the given listener from model delta notification.
* @param listener Listener to remove
*/
public void removeModelChangedListener(IModelChangedListener listener);
-
+
/**
* Causes the content provider to save the expansion and selection state
* of given element. The state is then restored as the tree is lazily
@@ -200,46 +200,46 @@ public interface ITreeModelContentProvider extends ILazyTreePathContentProvider
/**
* Instructs the content provider to process the given model delta. This
* mechanism can be used to control the view's layout (expanding, selecting
- * , etc.)
- *
+ * , etc.)
+ *
* @param delta The model delta to process.
- * @param mask Mask that can be used to suppress processing of some of the
+ * @param mask Mask that can be used to suppress processing of some of the
* delta flags
- *
+ *
* @since 3.6
*/
public void updateModel(IModelDelta delta, int mask);
/**
- * Instructs the content provider to cancel any pending state changes
+ * Instructs the content provider to cancel any pending state changes
* (i.e. SELECT, REVEAL, EXPAND, COLLAPSE) for the given path. Pending
- * state changes are changes the the viewer plans to re-apply to the
+ * state changes are changes the the viewer plans to re-apply to the
* viewer following a refresh. If the user changes viewer state while
- * the viewer is being refreshed, user's change should override the
- * previous state.
- *
+ * the viewer is being refreshed, user's change should override the
+ * previous state.
+ *
* @param path Path of the element for which to cancel pending changes.
* @param flags Flags indicating the changes to cancel.
*/
public void cancelRestore(TreePath path, int flags);
-
+
/**
- * Notifies the content provider that a client called {@link Viewer#setInput(Object)},
- * and the viewer input is changed.
- * This method is guaranteed to be called after {@link IContentProvider#inputChanged(Viewer, Object, Object)}
- *
+ * Notifies the content provider that a client called {@link Viewer#setInput(Object)},
+ * and the viewer input is changed.
+ * This method is guaranteed to be called after {@link IContentProvider#inputChanged(Viewer, Object, Object)}
+ *
* @param viewer The viewer that uses this content provider.
* @param oldInput Old input object.
* @param newInput New input object.
- *
+ *
* @since 3.8
*/
public void postInputChanged(IInternalTreeModelViewer viewer, Object oldInput, Object newInput);
-
+
/**
- * Notifies the receiver that the given element has had its
+ * Notifies the receiver that the given element has had its
* checked state modified in the viewer.
- *
+ *
* @param path Path of the element that had its checked state changed
* @param checked The new checked state of the element
* @return false if the check state should not change

Back to the top