KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > internal > navigator > extensions > SafeDelegateCommonLabelProvider


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  * Anton Leherbauer, Wind River - bug 146788
11  *******************************************************************************/
12 package org.eclipse.ui.internal.navigator.extensions;
13
14 import org.eclipse.jface.viewers.IColorProvider;
15 import org.eclipse.jface.viewers.IFontProvider;
16 import org.eclipse.jface.viewers.ILabelProvider;
17 import org.eclipse.jface.viewers.ILabelProviderListener;
18 import org.eclipse.jface.viewers.ITreePathLabelProvider;
19 import org.eclipse.jface.viewers.TreePath;
20 import org.eclipse.jface.viewers.ViewerLabel;
21 import org.eclipse.swt.graphics.Color;
22 import org.eclipse.swt.graphics.Font;
23 import org.eclipse.swt.graphics.Image;
24 import org.eclipse.ui.IMemento;
25 import org.eclipse.ui.navigator.ICommonContentExtensionSite;
26 import org.eclipse.ui.navigator.ICommonLabelProvider;
27 import org.eclipse.ui.navigator.IDescriptionProvider;
28
29 /**
30  * @since 3.2
31  */
32 public class SafeDelegateCommonLabelProvider implements ICommonLabelProvider, IColorProvider, IFontProvider, ITreePathLabelProvider {
33
34     private final ILabelProvider delegateLabelProvider;
35
36     /**
37      * @param aLabelProvider
38      * A non-null label provider.
39      *
40      */
41     public SafeDelegateCommonLabelProvider(ILabelProvider aLabelProvider) {
42         super();
43         delegateLabelProvider = aLabelProvider;
44     }
45
46     /**
47      * <p>
48      * No-op.
49      * </p>
50      *
51      * @see org.eclipse.ui.navigator.ICommonLabelProvider#init(ICommonContentExtensionSite)
52      */
53     public void init(ICommonContentExtensionSite aConfig) {
54     }
55
56     /**
57      * <p>
58      * If the delegate label provider implements <code>IDescriptionProvider</code>,
59      * it is used to retrieve the status bar message.
60      * </p>
61      * <p>
62      * Returns <b>null </b> otherwise, forcing the CommonNavigator to provide the default
63      * message.
64      * </p>
65      *
66      * @see org.eclipse.ui.navigator.ICommonLabelProvider#getDescription(java.lang.Object)
67      */
68     public String JavaDoc getDescription(Object JavaDoc element) {
69         /* The following few lines were contributed as part of a patch. */
70         if (delegateLabelProvider instanceof IDescriptionProvider) {
71             IDescriptionProvider provider = (IDescriptionProvider) delegateLabelProvider;
72             return provider.getDescription(element);
73         }
74         return null;
75     }
76
77     /**
78      * @param listener
79      */
80     public void addListener(ILabelProviderListener listener) {
81         delegateLabelProvider.addListener(listener);
82     }
83
84     /**
85      *
86      */
87     public void dispose() {
88         delegateLabelProvider.dispose();
89     }
90
91     /*
92      * (non-Javadoc)
93      *
94      * @see java.lang.Object#equals(java.lang.Object)
95      */
96     public boolean equals(Object JavaDoc obj) {
97         return delegateLabelProvider.equals(obj);
98     }
99
100     public Image getImage(Object JavaDoc element) {
101         return delegateLabelProvider.getImage(element);
102     }
103
104     public String JavaDoc getText(Object JavaDoc element) {
105         return delegateLabelProvider.getText(element);
106     }
107
108     /*
109      * (non-Javadoc)
110      *
111      * @see java.lang.Object#hashCode()
112      */
113     public int hashCode() {
114         return delegateLabelProvider.hashCode();
115     }
116
117     public boolean isLabelProperty(Object JavaDoc element, String JavaDoc property) {
118         return delegateLabelProvider.isLabelProperty(element, property);
119     }
120
121     /**
122      * @param listener
123      */
124     public void removeListener(ILabelProviderListener listener) {
125         delegateLabelProvider.removeListener(listener);
126     }
127
128     /*
129      * (non-Javadoc)
130      *
131      * @see java.lang.Object#toString()
132      */
133     public String JavaDoc toString() {
134         return delegateLabelProvider.toString();
135     }
136
137     public void restoreState(IMemento aMemento) {
138
139     }
140
141     public void saveState(IMemento aMemento) {
142
143     }
144
145     /* (non-Javadoc)
146      * @see org.eclipse.jface.viewers.ITreePathLabelProvider#updateLabel(org.eclipse.jface.viewers.ViewerLabel, org.eclipse.jface.viewers.TreePath)
147      */
148     public void updateLabel(ViewerLabel label, TreePath elementPath) {
149         if (delegateLabelProvider instanceof ITreePathLabelProvider) {
150             ITreePathLabelProvider tplp = (ITreePathLabelProvider) delegateLabelProvider;
151             String JavaDoc text = label.getText() != null ? label.getText() : ""; //$NON-NLS-1$
152 Image image = label.getImage();
153             tplp.updateLabel(label, elementPath);
154             if(label.getText() == null)
155                 label.setText(text);
156             if(label.getImage() == null && image != null)
157                 label.setImage(image);
158         } else {
159             Image image = getImage(elementPath.getLastSegment());
160             if(image != null)
161                 label.setImage(image);
162             String JavaDoc text = getText(elementPath.getLastSegment());
163             if(text != null)
164                 label.setText(text);
165         }
166     }
167
168     /* (non-Javadoc)
169      * @see org.eclipse.jface.viewers.IColorProvider#getForeground(java.lang.Object)
170      */
171     public Color getForeground(Object JavaDoc element) {
172         if(delegateLabelProvider instanceof IColorProvider) {
173             return ((IColorProvider)delegateLabelProvider).getForeground(element);
174         }
175         return null;
176     }
177
178     /* (non-Javadoc)
179      * @see org.eclipse.jface.viewers.IColorProvider#getBackground(java.lang.Object)
180      */
181     public Color getBackground(Object JavaDoc element) {
182         if(delegateLabelProvider instanceof IColorProvider) {
183             return ((IColorProvider)delegateLabelProvider).getBackground(element);
184         }
185         return null;
186     }
187
188     /* (non-Javadoc)
189      * @see org.eclipse.jface.viewers.IFontProvider#getFont(java.lang.Object)
190      */
191     public Font getFont(Object JavaDoc element) {
192         if(delegateLabelProvider instanceof IFontProvider) {
193             return ((IFontProvider)delegateLabelProvider).getFont(element);
194         }
195         return null;
196     }
197 }
198
Popular Tags