IDescriptionProvider


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   *******************************************************************************/
11  package org.eclipse.ui.navigator;
12  
13  /**
14   * 
15   * Label providers (as specified by the <i>labelProvider</i> attribute of the
16   * <b>org.eclipse.ui.navigator.navigatorContent</b> extension point) may 
17   * choose to also implement this interface in order to provide text for 
18   * the status bar at the bottom of the Eclipse window. 
19   * 
20   * <p>
21   * Clients may implement this interface, but are not required to do so.
22   * </p>
23   * 
24   * @since 3.2
25   */
26  public interface IDescriptionProvider {
27  
28      /**
29       * <p>
30       * Provide a description for the status bar view, if available. A default
31       * string of the form "(x) items selected" will be used if this method
32       * choosed to return null.
33       * </p>
34       * 
35       * <p>
36       * The empty string ("") will be respected as a valid value if returned.
37       * Return <b>null </b> if the extension defers to the default method of
38       * supplying status bar descriptions.
39       * </p>
40       * 
41       * @param anElement
42       *            The element selected in the Navigator
43       * @return A description for the status bar view, or null if not available.
44       */
45      String   getDescription(Object   anElement);
46  
47  }
48
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags