KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > team > ui > history > IHistoryView


1 /*******************************************************************************
2  * Copyright (c) 2006 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.team.ui.history;
12
13 import org.eclipse.team.core.history.IFileHistory;
14
15 /**
16  * This interface provides a way for clients to request the History View
17  * to display the history for a given object.
18  *
19  * <p>
20  * This interface is not intended to be implemented by clients.
21  *
22  * @since 3.2
23  * @see IFileHistory
24  * @see IHistoryPage
25  */
26 public interface IHistoryView {
27     
28     /**
29      * The id for this view.
30      * @since 3.3
31      */
32     public static final String JavaDoc VIEW_ID = "org.eclipse.team.ui.GenericHistoryView"; //$NON-NLS-1$
33
34     /**
35      * Returns the history page that is currently being displayed by the
36      * history view.
37      * TODO: Need to explain what page this is. Is it the visible page?
38      * @return the history page
39      */
40     public IHistoryPage getHistoryPage();
41     
42     /**
43      * Shows the history for the passed in object. This method is equivalent to
44      * {@link #showHistoryFor(Object, boolean)} with <code>force</code>
45      * set to <code>false</code>.
46      *
47      * @param object the input whose history is to be displayed
48      * @return returns the history page that the passed in object is being shown
49      * in or null if no appropriate page can be found.
50      */
51     public IHistoryPage showHistoryFor(Object JavaDoc object);
52     
53     /**
54      * Shows the history for the given object. If force is <code>false</code>,
55      * the history may be displayed in another instance of {@link IHistoryView}.
56      * For example, if the target view is pinned, the history will be shown in another
57      * view instance. If force is <code>true</code>, the history will be shown in this view
58      * instance regardless of the view state.
59      *
60      * @param object the input whose history is to be displayed
61      * @param force whether this view should show the input even if it is pinned
62      * @return returns the history page that the passed in object is being shown
63      * in or <code>null</code> if no appropriate page can be found.
64      * @since 3.3
65      */
66     public IHistoryPage showHistoryFor(Object JavaDoc object, boolean force);
67     
68 }
69
Popular Tags