01: /*******************************************************************************
02: * Copyright (c) 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.jface.viewers;
11:
12: import org.eclipse.swt.graphics.Image;
13:
14: /**
15: * The LabelDecorator is an abstract superclass of ILabelDecorators
16: * that support IDecorationContext.
17: * @see IDecorationContext
18: * @since 3.2
19: *
20: */
21: public abstract class LabelDecorator implements ILabelDecorator {
22:
23: /**
24: * Returns an image that is based on the given image,
25: * but decorated with additional information relating to the state
26: * of the provided element taking into account the provided context.
27: *
28: * Text and image decoration updates can occur as a result of other updates
29: * within the workbench including deferred decoration by background processes.
30: * Clients should handle labelProviderChangedEvents for the given element to get
31: * the complete decoration.
32: * @see LabelProviderChangedEvent
33: * @see IBaseLabelProvider#addListener
34: *
35: * @param image the input image to decorate, or <code>null</code> if the element has no image
36: * @param element the element whose image is being decorated
37: * @param context additional context information about the element being decorated
38: * @return the decorated image, or <code>null</code> if no decoration is to be applied
39: *
40: * @see org.eclipse.jface.resource.CompositeImageDescriptor
41: */
42: public abstract Image decorateImage(Image image, Object element,
43: IDecorationContext context);
44:
45: /**
46: * Returns a text label that is based on the given text label,
47: * but decorated with additional information relating to the state
48: * of the provided element taking into account the provided context.
49: *
50: * Text and image decoration updates can occur as a result of other updates
51: * within the workbench including deferred decoration by background processes.
52: * Clients should handle labelProviderChangedEvents for the given element to get
53: * the complete decoration.
54: * @see LabelProviderChangedEvent
55: * @see IBaseLabelProvider#addListener
56: *
57: * @param text the input text label to decorate
58: * @param element the element whose image is being decorated
59: * @param context additional context information about the element being decorated
60: * @return the decorated text label, or <code>null</code> if no decoration is to be applied
61: */
62: public abstract String decorateText(String text, Object element,
63: IDecorationContext context);
64:
65: /**
66: * Prepare the element for decoration. If it is already decorated and ready for update
67: * return true. If decoration is pending return false.
68: * @param element The element to be decorated
69: * @param originalText The starting text.
70: * @param context The decoration context
71: * @return boolean <code>true</code> if the decoration is ready for this element
72: */
73: public abstract boolean prepareDecoration(Object element,
74: String originalText, IDecorationContext context);
75: }
|