01: /*******************************************************************************
02: * Copyright (c) 2004, 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;
11:
12: /**
13: * Extends {@link IWorkbenchPart}, adding the name and status text properties.
14: * Prior to 3.0, a view's title was often modified to show both the part
15: * name and extra status text. With this interface, the distinction is
16: * made more explicit.
17: *
18: * @since 3.0
19: */
20: public interface IWorkbenchPart2 extends IWorkbenchPart {
21: /**
22: * Returns the name of this part. If this value changes the part must fire a
23: * property listener event with {@link IWorkbenchPartConstants#PROP_PART_NAME}.
24: *
25: * @return the name of this view, or the empty string if the name is being managed
26: * by the workbench (not <code>null</code>)
27: */
28: public String getPartName();
29:
30: /**
31: * Returns the content description of this part. The content description is an optional
32: * user-readable string that describes what is currently being displayed in the part.
33: * By default, the workbench will display the content description in a line
34: * near the top of the view or editor.
35: * An empty string indicates no content description
36: * text. If this value changes the part must fire a property listener event
37: * with {@link IWorkbenchPartConstants#PROP_CONTENT_DESCRIPTION}.
38: *
39: * @return the content description of this part (not <code>null</code>)
40: */
41: public String getContentDescription();
42:
43: }
|