01: /*******************************************************************************
02: * Copyright (c) 2007 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.properties.tabbed;
11:
12: import java.util.List;
13:
14: /**
15: * Represents a tab descriptor for the tabbed property view.
16: * <p>
17: * This interface should not be extended or implemented. New instances should be
18: * created using <code>AbstractTabDescriptor</code>.
19: * </p>
20: *
21: * @author Anthony Hunter
22: * @since 3.4
23: */
24: public interface ITabDescriptor extends ITabItem {
25:
26: /**
27: * If afterTab is not specified in the descriptor, we default to be the top
28: * tab.
29: */
30: public static final String TOP = "top"; //$NON-NLS-1$
31:
32: /**
33: * Instantiate this tab's sections.
34: *
35: * @return The tab contents for this section.
36: */
37: public TabContents createTab();
38:
39: /**
40: * Get the identifier of the tab after which this tab should be displayed.
41: * When two or more tabs belong to the same category, they are sorted by the
42: * after tab values.
43: *
44: * @return the identifier of the tab.
45: */
46: public String getAfterTab();
47:
48: /**
49: * Get the category this tab belongs to.
50: *
51: * @return Get the category this tab belongs to.
52: */
53: public String getCategory();
54:
55: /**
56: * Get the unique identifier for the tab.
57: *
58: * @return the unique identifier for the tab.
59: */
60: public String getId();
61:
62: /**
63: * Get the text label for the tab.
64: *
65: * @return the text label for the tab.
66: */
67: public String getLabel();
68:
69: /**
70: * Get the list of section descriptors for the tab.
71: *
72: * @return the list of section descriptors for the tab.
73: */
74: public List getSectionDescriptors();
75: }
|