KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > team > ui > mapping > ITeamContentProviderDescriptor


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.team.ui.mapping;
12
13 import org.eclipse.core.runtime.CoreException;
14 import org.eclipse.jface.preference.IPreferencePage;
15 import org.eclipse.jface.resource.ImageDescriptor;
16
17 /**
18  * A description of a single extension registered with the
19  * <code>org.eclipse.team.ui.teamContentProviders</code>
20  * extension point.
21  *
22  * * <p>
23  * This interface is not intended to be implemented by clients.
24  * @since 3.2
25  */
26 public interface ITeamContentProviderDescriptor {
27
28     /**
29      * Return the id of the content extension registered with
30      * the <code>org.eclipse.ui.navigator.navigatorContent</code> extension point
31      * that applies to the descriptors model provider.
32      * @return id of the content extension registered with
33      * the <code>org.eclipse.ui.navigator.navigatorContent</code> extension point
34      */
35     public String JavaDoc getContentExtensionId();
36
37     /**
38      * Return the id of the model provider to which this content provider applies.
39      * @return the id of the model provider to which this content provider applies
40      */
41     public String JavaDoc getModelProviderId();
42
43     /**
44      * Return an image descriptor that can be displayed with this content
45      * extension.
46      * @return an image descriptor that can be displayed with this content
47      * extension
48      */
49     public ImageDescriptor getImageDescriptor();
50
51     /**
52      * Return a preference page that can be displayed to configure
53      * the content provider of this extension.
54      * @return a preference page that can be displayed to configure
55      * the content provider of this extension
56      * @throws CoreException
57      */
58     public IPreferencePage createPreferencePage() throws CoreException;
59     
60     /**
61      * Return whether this content provider is enabled. If it is not
62      * enabled, it should not be included in any viewers.
63      * @return whether this content provider is enabled
64      */
65     public boolean isEnabled();
66
67     /**
68      * Returns the name specified for this content provider as specified in the extension point.
69      * @return a string containing the name or null if no name has been specified
70      */
71     public String JavaDoc getName();
72     
73     /**
74      * Return whether the FLAT layout is supported by this content provider.
75      * @return whether the FLAT layout is supported by this content provider
76      * @see ITeamContentProviderManager#PROP_PAGE_LAYOUT
77      * @since 3.3
78      */
79     public boolean isFlatLayoutSupported();
80
81 }
82
Popular Tags