KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > core > internal > databinding > observable > tree > IViewerUpdate


1 /*******************************************************************************
2  * Copyright (c) 2006, 2007 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/

11 package org.eclipse.core.internal.databinding.observable.tree;
12
13 import org.eclipse.core.runtime.IProgressMonitor;
14 import org.eclipse.core.runtime.IStatus;
15
16 /**
17  * A context sensitive viewer update request.
18  *
19  * @since 3.3
20  */

21 public interface IViewerUpdate extends IProgressMonitor {
22
23     /**
24      * Sets the status of this request, possibly <code>null</code>.
25      * When a request fails, the status indicates why the request failed.
26      * A <code>null</code> status is considered to be successful.
27      *
28      * @param status request status
29      */

30     public void setStatus(IStatus status);
31     
32     /**
33      * Returns the status of this request, or <code>null</code>.
34      *
35      * @return request status or <code>null</code>
36      */

37     public IStatus getStatus();
38     
39     /**
40      * Returns the model element corresponding to the given tree path.
41      * Returns the root element for the empty path.
42      *
43      * @param path viewer tree path
44      * @return corresponding model element
45      */

46     public Object JavaDoc getElement(TreePath path);
47 }
48
Popular Tags