KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > internal > registry > IActionSetDescriptor


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