KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 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.jface.viewers.Viewer;
14 import org.eclipse.ui.PartInitException;
15
16 /**
17  * Interface for {@link org.eclipse.ui.part.Page} subclasses that can appear in
18  * the synchronize view {@link ISynchronizeView} and other views, editors or
19  * dialogs that display synchronization information. It is not a requirement
20  * that pages that appear in the synchronize view implement this interface.
21  *
22  * @since 3.0
23  */
24 public interface ISynchronizePage {
25     
26     /**
27      * Initialize this page with workbench part that contains the page.
28      * This method will be called after the <code>Page#init(IPageSite)</code>
29      * but before <code>Page#createControl(Composite)</code>
30      *
31      * @param site the workbench part for the view containing the page
32      * @throws PartInitException
33      */
34     public void init(ISynchronizePageSite site) throws PartInitException;
35     
36     /**
37      * Returns the viewer associated with this page or <code>null</code> if the page
38      * doesn't have a viewer.
39      *
40      * @return the viewer associated with this page or <code>null</code> if the page
41      * doesn't have a viewer.
42      */
43     public Viewer getViewer();
44
45     /**
46      * Callback that is invoked from the synchronize configuration whenever a
47      * property's value is about to be changed. The page can react to the change
48      * before change events are fired or veto the change.
49      *
50      * @param configuration the synchronize page configuration
51      * @param key the property key
52      * @param newValue
53      * @return <code>true<code> if the property change should continue to be
54      * fired to other listeners or <code>false</code> to veto the property change
55      * notification.
56      */
57     public boolean aboutToChangeProperty(ISynchronizePageConfiguration configuration, String JavaDoc key, Object JavaDoc newValue);
58
59 }
60
Popular Tags