KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > team > ui > synchronize > ISynchronizeView


1 /*******************************************************************************
2  * Copyright (c) 2000, 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.synchronize;
12
13 import org.eclipse.ui.IViewPart;
14
15 /**
16  * A view that displays synchronization participants that are registered with the
17  * synchronize manager. This is essentially a generic container that allows
18  * multiple {@link ISynchronizeParticipant} implementations to share the same
19  * view. The only behavior provided by the view is a mechanism for switching
20  * between participants.
21  * <p>
22  * Clients can not add viewActions to this view because they will be global
23  * to all participants. Instead, add participant specific actions as described
24  * in {@link org.eclipse.team.ui.synchronize.ISynchronizePageConfiguration}.
25  * </p>
26  * <p>
27  * Clients are not intended to implement this interface.
28  * </p>
29  * @see ISynchronizeManager#showSynchronizeViewInActivePage()
30  * @since 3.0
31  */
32 public interface ISynchronizeView extends IViewPart {
33     /**
34      * The id for this view
35      */
36     public static final String JavaDoc VIEW_ID = "org.eclipse.team.sync.views.SynchronizeView"; //$NON-NLS-1$
37
38     /**
39      * This id is no longer used.
40      * @deprecated not used, please use {@link #VIEW_ID} instead.
41      */
42     public static final String JavaDoc COMPARE_VIEW_ID = "org.eclipse.team.sync.views.CompareView"; //$NON-NLS-1$
43
44     /**
45      * Displays the given synchronize participant in the Synchronize View. This
46      * has no effect if this participant is already being displayed.
47      *
48      * @param participant participant to be displayed, cannot be <code>null</code>
49      */
50     public void display(ISynchronizeParticipant participant);
51     
52     /**
53      * Returns the participant currently being displayed in the Synchronize View
54      * or <code>null</code> if none.
55      *
56      * @return the participant currently being displayed in the Synchronize View
57      * or <code>null</code> if none
58      */
59     public ISynchronizeParticipant getParticipant();
60 }
61
Popular Tags