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