01: /*******************************************************************************
02: * Copyright (c) 2003, 2006 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.application;
11:
12: import org.eclipse.jface.action.IAction;
13: import org.eclipse.jface.action.ICoolBarManager;
14: import org.eclipse.jface.action.IMenuManager;
15: import org.eclipse.jface.action.IStatusLineManager;
16:
17: /**
18: * Interface providing special access for configuring the action bars
19: * of a workbench window.
20: * <p>
21: * Note that these objects are only available to the main application
22: * (the plug-in that creates and owns the workbench).
23: * </p>
24: * <p>
25: * This interface is not intended to be implemented by clients.
26: * </p>
27: *
28: * @see org.eclipse.ui.application.WorkbenchAdvisor#fillActionBars
29: * @since 3.0
30: */
31: public interface IActionBarConfigurer {
32:
33: /**
34: * Returns the workbench window configurer for the window
35: * containing this configurer's action bars.
36: *
37: * @return the workbench window configurer
38: * @since 3.1
39: */
40: public IWorkbenchWindowConfigurer getWindowConfigurer();
41:
42: /**
43: * Returns the menu manager for the main menu bar of a workbench window.
44: *
45: * @return the menu manager
46: */
47: public IMenuManager getMenuManager();
48:
49: /**
50: * Returns the status line manager of a workbench window.
51: *
52: * @return the status line manager
53: */
54: public IStatusLineManager getStatusLineManager();
55:
56: /**
57: * Returns the cool bar manager of the workbench window.
58: *
59: * @return the cool bar manager
60: */
61: public ICoolBarManager getCoolBarManager();
62:
63: /**
64: * Register the action as a global action with a workbench
65: * window.
66: * <p>
67: * For a workbench retarget action
68: * ({@link org.eclipse.ui.actions.RetargetAction RetargetAction})
69: * to work, it must be registered.
70: * You should also register actions that will participate
71: * in custom key bindings.
72: * </p>
73: *
74: * @param action the global action
75: * @see org.eclipse.ui.actions.RetargetAction
76: */
77: public void registerGlobalAction(IAction action);
78:
79: }
|