01: /*******************************************************************************
02: * Copyright (c) 2000, 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.internal.registry;
11:
12: import org.eclipse.core.runtime.CoreException;
13: import org.eclipse.core.runtime.IConfigurationElement;
14:
15: /**
16: * A named set of actions which is defined as an extension to the workbench
17: * via the standard workbench actions extension point
18: * (<code>"org.eclipse.ui.workbenchActions"</code>).
19: * <p>
20: * [Issue: This interface is not exposed in API, but time may
21: * demonstrate that it should be. For the short term leave it be.
22: * In the long term its use should be re-evaluated. ]
23: * </p>
24: * <p>
25: * This interface is not intended to be implemented by clients.
26: * </p>
27: * @see ActionSetRegistry
28: */
29: public interface IActionSetDescriptor {
30:
31: /**
32: * Creates a new action set from this descriptor.
33: * <p>
34: * [Issue: Consider throwing WorkbenchException rather than CoreException.]
35: * </p>
36: *
37: * @return the new action set
38: * @exception CoreException if the action set cannot be created
39: */
40: public IActionSet createActionSet() throws CoreException;
41:
42: /**
43: * Returns the description of this action set.
44: * This is the value of its <code>"description"</code> attribute.
45: *
46: * @return the description
47: */
48: public String getDescription();
49:
50: /**
51: * Returns the id of this action set.
52: * This is the value of its <code>"id"</code> attribute.
53: *
54: * @return the action set id
55: */
56: public String getId();
57:
58: /**
59: * Returns the label of this action set.
60: * This is the value of its <code>"label"</code> attribute.
61: *
62: * @return the label
63: */
64: public String getLabel();
65:
66: /**
67: * Returns whether this action set is initially visible.
68: *
69: * @return whether this action set is initially visible
70: */
71: public boolean isInitiallyVisible();
72:
73: /**
74: * Sets whether this action set is initially visible.
75: *
76: * @param visible whether the action set should be visible initially.
77: * @since 3.0
78: */
79: public void setInitiallyVisible(boolean visible);
80:
81: /**
82: * Returns the conconfigurationfig element.
83: *
84: * @return the configuration element
85: * @since 3.1
86: */
87: public IConfigurationElement getConfigurationElement();
88: }
|