IDelayedLabelDecorator


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

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags