IViewCategory


1   /*******************************************************************************
2    * Copyright (c) 2005 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.views;
12  
13  import org.eclipse.core.runtime.IPath;
14  
15  /**
16   * Represents a categorization of views.
17   * 
18   * <p>
19   * This interface is not intended to be implemented by clients.
20   * </p>
21   * 
22   * @since 3.1
23   */
24  public interface IViewCategory {
25  
26      /**
27       * Return the views contained within this category. Never <code>null</code>,
28       * but may be empty.
29       * 
30       * @return the views contained within this category
31       */
32      IViewDescriptor[] getViews();
33  
34      /**
35       * Return the id of this category.  Never <code>null</code>.
36       * 
37       * @return the id
38       */
39      String   getId();
40  
41      /**
42       * Return the human readable name of this view category.  Never <code>null</code>.
43       * 
44       * @return the label
45       */
46      String   getLabel();
47  
48      /**
49       * Return this categories path. The segments of this path will correspond to
50       * category ids.
51       * 
52       * @return the path
53       */
54      IPath getPath();
55  }
56

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags