Skip to main content
aboutsummaryrefslogblamecommitdiffstats
path: root/plugins/facet/org.eclipse.papyrus.emf.facet.custom.ui/src/org/eclipse/papyrus/emf/facet/custom/ui/ICustomizedLabelProvider.java
blob: 63da4e21b166889e2ba3f4c1a400724577be9001 (plain) (tree) 
d98116b5b37 ^




557dfaa5334 ^

d98116b5b37 ^

557dfaa5334 ^



d98116b5b37 ^




















































































1
2
3
4

5

6

7
8
9

10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93




                                                                    
                                                                        
                                                            


                                          



















































































                                                                                                                                         
/**
 *  Copyright (c) 2011 Mia-Software.
 *
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License 2.0
 *  which accompanies this distribution, and is available at
 *  https://www.eclipse.org/legal/epl-2.0/
 *
 *  SPDX-License-Identifier: EPL-2.0
 *
 *  Contributors:
 *  	Gregoire Dupe (Mia-Software) - Bug 361794 - [Restructuring] New customization meta-model
 *      Gregoire Dupe (Mia-Software) - Bug 369987 - [Restructuring][Table] Switch to the new customization and facet framework
 *      Vincent Lorenzo (CEA-LIST)   - Bug 372644 - Create Customizable tooltips for the TreeViewer using a CustomizableLabelProvider
 *      Gregoire Dupe (Mia-Software) - Bug 373078 - API Cleaning
 *      Mickael ADAM (ALL4TEC) - mickael.adam@all4tec.net - Bug 500219 - implementation of IStyledLabelProvider
 */
package org.eclipse.papyrus.emf.facet.custom.ui;

import org.eclipse.emf.ecore.ETypedElement;
import org.eclipse.jface.viewers.DelegatingStyledCellLabelProvider.IStyledLabelProvider;
import org.eclipse.jface.viewers.IColorProvider;
import org.eclipse.jface.viewers.IFontProvider;
import org.eclipse.jface.viewers.ILabelProvider;
import org.eclipse.jface.viewers.StyledString;
import org.eclipse.papyrus.emf.facet.custom.core.ICustomizationManager;
import org.eclipse.swt.graphics.Image;

/**
 * This interface allows to use a {@link ILabelProvider}, an {@link IColorProvider} and an {@link IFontProvider} which is implemented and
 * customizable using the EMF Facet customization mechanism.
 *
 * @author Gregoire Dupe
 * @noextend This interface is not intended to be extended by clients.
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface ICustomizedLabelProvider extends ILabelProvider,
		IColorProvider, IFontProvider, ICustomizedToolTipLabelProvider, IStyledLabelProvider {
	/**
	 * This method returns the customization manager used by the label provider. The
	 * customization stack updates have to be done using this {@link ICustomizationManager}.
	 *
	 * @return the customization manager used by the content provider.
	 */
	ICustomizationManager getCustomizationManager();

	boolean isUnderlined(Object element, ETypedElement eTypedElement);

	boolean isStruckthrough(Object element, ETypedElement eTypedElement);

	Image getTopLeftOverlay(Object element, ETypedElement eTypedElement);

	Image getTopMiddleOverlay(Object element, ETypedElement eTypedElement);

	Image getTopRightOverlay(Object element, ETypedElement eTypedElement);

	Image getBottomLeftOverlay(Object element, ETypedElement eTypedElement);

	Image getBottomMiddleOverlay(Object element, ETypedElement eTypedElement);

	Image getBottomRightOverlay(Object element, ETypedElement eTypedElement);

	String getText(Object element, ETypedElement eTypedElement);

	Image getImage(Object element, ETypedElement eTypedElement);

	/**
	 * @since 0.2
	 */
	ICustomizedLabelProvider cloneLabelProvider();

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.jface.viewers.DelegatingStyledCellLabelProvider.IStyledLabelProvider#getStyledText(java.lang.Object)
	 * 
	 * @since 3.0
	 */
	@Override
	default StyledString getStyledText(final Object element) {
		return new StyledString(getText(element));
	}

	/**
	 * Returns the styled text label for the given element.
	 * 
	 * @since 3.0
	 */
	default StyledString getStyledText(final Object element, final ETypedElement eTypedElement) {
		return new StyledString(getText(element, eTypedElement));
	}

}

Back to the top