KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > navigator > ICommonLabelProvider


1 /*******************************************************************************
2  * Copyright (c) 2003, 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.ui.navigator;
12
13 import org.eclipse.jface.viewers.ILabelProvider;
14
15 /**
16  *
17  * Allows extensions to vary their behavior based on properties in the extension
18  * model and the given memento.
19  *
20  * <p>
21  * Clients should refer to the <b>org.eclipse.ui.navigator.navigatorContent</b>
22  * extension point for more information on building a content extension.
23  * </p>
24  * <p>
25  * Clients should not dispose of any Image Resources that might be shared by
26  * other extensions when their Label Provider is disposed. When a content extension
27  * is deactivated, both its content and label providers are disposed, but the
28  * viewer remains visible to the user. If clients dispose of Image Resources used
29  * by other extensions, then it will cause problems for those extensions and the
30  * viewer in general.
31  * </p>
32  * <p>
33  * Clients need not implement this interface if there is no cause to do so.
34  * {@link org.eclipse.jface.viewers.ILabelProvider} is respected by the Common
35  * Navigator.
36  * </p>
37  *
38  *
39  * @since 3.2
40  */
41 public interface ICommonLabelProvider extends ILabelProvider, IMementoAware,
42         IDescriptionProvider {
43
44     /**
45      * Initialize the label provider with the given configuration.
46      *
47      * @param aConfig
48      * The extension site provides information that some extensions
49      * will find useful to configure themselves properly in a
50      * particular viewer.
51      *
52      * @see ICommonContentProvider
53      */
54     void init(ICommonContentExtensionSite aConfig);
55
56 }
57
Popular Tags