| /******************************************************************************* |
| * Copyright (c) 2004, 2006 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/epl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.ui; |
| |
| /** |
| * Extends {@link IWorkbenchPart}, adding the name and status text properties. |
| * Prior to 3.0, a view's title was often modified to show both the part |
| * name and extra status text. With this interface, the distinction is |
| * made more explicit. |
| * |
| * @since 1.0 |
| */ |
| public interface IWorkbenchPart2 extends IWorkbenchPart { |
| /** |
| * Returns the name of this part. If this value changes the part must fire a |
| * property listener event with {@link IWorkbenchPartConstants#PROP_PART_NAME}. |
| * |
| * @return the name of this view, or the empty string if the name is being managed |
| * by the workbench (not <code>null</code>) |
| */ |
| public String getPartName(); |
| |
| /** |
| * Returns the content description of this part. The content description is an optional |
| * user-readable string that describes what is currently being displayed in the part. |
| * By default, the workbench will display the content description in a line |
| * near the top of the view or editor. |
| * An empty string indicates no content description |
| * text. If this value changes the part must fire a property listener event |
| * with {@link IWorkbenchPartConstants#PROP_CONTENT_DESCRIPTION}. |
| * |
| * @return the content description of this part (not <code>null</code>) |
| */ |
| public String getContentDescription(); |
| |
| } |
