IWorkbenchPart2


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