01: /*******************************************************************************
02: * Copyright (c) 2004, 2007 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: /**
13: * A delayed label decorator is a label decorator that may not have a
14: * decoration available immediately. This interface defines the methods for
15: * requesting the preparation of a decorator for an object and for querying
16: * if the decorator is ready. Interested parties should register an
17: * ILabelProviderListener with a delayed label decorator in order to be informed
18: * when the decoration is ready.
19: * @since 3.0
20: */
21: public interface IDelayedLabelDecorator extends ILabelDecorator {
22:
23: /**
24: * Prepare the element for decoration. If it is already decorated and ready for update
25: * return true. If decoration is pending return false.
26: * @param element The element to be decorated
27: * @param originalText The starting text.
28: * @return boolean <code>true</code> if the decoration is ready for this element
29: */
30:
31: public boolean prepareDecoration(Object element, String originalText);
32:
33: }
|