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