01: /*******************************************************************************
02: * Copyright (c) 2003, 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.commands;
11:
12: import java.util.Collection;
13:
14: /**
15: * An instance of this interface provides support for managing commands at the
16: * <code>IWorkbench</code> level.
17: * <p>
18: * This interface is not intended to be extended or implemented by clients.
19: * </p>
20: *
21: * @since 3.0
22: * @deprecated Please use <code>ICommandService</code> and
23: * <code>IHandlerService</code> instead.
24: * @see org.eclipse.ui.commands.ICommandService
25: * @see org.eclipse.ui.handlers.IHandlerService
26: */
27: public interface IWorkbenchCommandSupport {
28:
29: /**
30: * Adds a single handler submissions for consideration by the workbench. The
31: * submission indicates to the workbench a set of conditions under which the
32: * handler should become active. The workbench, however, ultimately decides
33: * which handler becomes active (in the event of conflicts or changes in
34: * state). This could cause the handlers for one or more commands to change.
35: *
36: * @param handlerSubmission
37: * The submission to be added; must not be <code>null</code>.
38: */
39: void addHandlerSubmission(HandlerSubmission handlerSubmission);
40:
41: /**
42: * Adds a collection of handler submissions for consideration by the
43: * workbench. The submission indicates to the workbench a set of conditions
44: * under which the handler should become active. The workbench, however,
45: * ultimately decides which handler becomes active (in the event of
46: * conflicts or changes in state). This could cause the handlers for one or
47: * more commands to change.
48: *
49: * @param handlerSubmissions
50: * The submissions to be added; must not be <code>null</code>,
51: * and must contain zero or more instances of
52: * <code>HandlerSubmission</code>.
53: */
54: void addHandlerSubmissions(Collection handlerSubmissions);
55:
56: /**
57: * Returns the command manager for the workbench.
58: *
59: * @return the command manager for the workbench. Guaranteed not to be
60: * <code>null</code>.
61: */
62: ICommandManager getCommandManager();
63:
64: /**
65: * Removes a single handler submission from consideration by the workbench.
66: * The handler submission must be the same as the one added (not just
67: * equivalent). This could cause the handlers for one or more commands to
68: * change.
69: *
70: * @param handlerSubmission
71: * The submission to be removed; must not be <code>null</code>.
72: */
73: void removeHandlerSubmission(HandlerSubmission handlerSubmission);
74:
75: /**
76: * Removes a single handler submission from consideration by the workbench.
77: * The handler submission must be the same as the one added (not just
78: * equivalent). This could cause the handlers for one or more commands to
79: * change.
80: *
81: * @param handlerSubmissions
82: * The submissions to be removed; must not be <code>null</code>,
83: * and must contain instances of <code>HandlerSubmission</code>
84: * only.
85: */
86: void removeHandlerSubmissions(Collection handlerSubmissions);
87: }
|