blob: 77693438c70bb0a189f5f5f6f5c9aa8197d00de1 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2000, 2003 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui.internal;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.SortedSet;
import org.eclipse.core.resources.IContainer;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.MultiStatus;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Status;
import org.eclipse.jface.action.Action;
import org.eclipse.jface.action.ActionContributionItem;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.action.IContributionItem;
import org.eclipse.jface.action.IContributionManager;
import org.eclipse.jface.action.IContributionManagerOverrides;
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.action.MenuManager;
import org.eclipse.jface.action.StatusLineManager;
import org.eclipse.jface.action.SubMenuManager;
import org.eclipse.jface.action.ToolBarManager;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.window.ApplicationWindow;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.BusyIndicator;
import org.eclipse.swt.events.MouseAdapter;
import org.eclipse.swt.events.MouseEvent;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.ShellAdapter;
import org.eclipse.swt.events.ShellEvent;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.CoolBar;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Layout;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.ToolBar;
import org.eclipse.swt.widgets.ToolItem;
import org.eclipse.swt.widgets.Widget;
import org.eclipse.ui.IActionBars;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.IElementFactory;
import org.eclipse.ui.IMemento;
import org.eclipse.ui.IPageListener;
import org.eclipse.ui.IPartService;
import org.eclipse.ui.IPersistableElement;
import org.eclipse.ui.IPerspectiveDescriptor;
import org.eclipse.ui.ISelectionService;
import org.eclipse.ui.IViewReference;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchActionConstants;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.WorkbenchException;
import org.eclipse.ui.help.WorkbenchHelp;
import org.eclipse.ui.internal.commands.SequenceMachine;
import org.eclipse.ui.internal.commands.Manager;
import org.eclipse.ui.internal.commands.Sequence;
import org.eclipse.ui.internal.commands.Stroke;
import org.eclipse.ui.internal.dialogs.MessageDialogWithToggle;
import org.eclipse.ui.internal.misc.Assert;
import org.eclipse.ui.internal.misc.UIStats;
import org.eclipse.ui.internal.registry.IActionSet;
/**
* A window within the workbench.
*/
public class WorkbenchWindow extends ApplicationWindow
implements IWorkbenchWindow
{
private int number;
private Workbench workbench;
private PageList pageList = new PageList();
private PageListenerList pageListeners = new PageListenerList();
private PerspectiveListenerListOld perspectiveListeners = new PerspectiveListenerListOld();
private IPartDropListener partDropListener;
private WWinPerspectiveService perspectiveService = new WWinPerspectiveService(this);
private WWinKeyBindingService keyBindingService;
private WWinPartService partService = new WWinPartService(this);
private ActionPresentation actionPresentation;
private WWinActionBars actionBars;
private Label separator2;
private Label separator3;
private ToolBarManager shortcutBar;
private ShortcutBarPart shortcutBarPart;
private ShortcutBarPartDragDrop shortcutDND;
private WorkbenchActionBuilder actionBuilder;
private boolean updateDisabled = true;
private boolean closing = false;
private boolean shellActivated = false;
private String workspaceLocation;
private Menu perspectiveBarMenu;
private Menu fastViewBarMenu;
private MenuItem restoreItem;
private CoolBarManager coolBarManager = new CoolBarManager();
private Label noOpenPerspective;
private boolean showShortcutBar = true;
private boolean showStatusLine = true;
private boolean showToolBar = true;
// constants for shortcut bar group ids
static final String GRP_PAGES = "pages";//$NON-NLS-1$
static final String GRP_PERSPECTIVES = "perspectives";//$NON-NLS-1$
static final String GRP_FAST_VIEWS = "fastViews";//$NON-NLS-1$
// static fields for inner classes.
static final int VGAP= 0;
static final int CLIENT_INSET = 3;
static final int BAR_SIZE = 23;
/**
* The layout for the workbench window's shell.
*/
class WorkbenchWindowLayout extends Layout {
protected Point computeSize(Composite composite, int wHint, int hHint, boolean flushCache)
{
if (wHint != SWT.DEFAULT && hHint != SWT.DEFAULT)
return new Point(wHint, hHint);
Point result= new Point(0, 0);
Control[] ws= composite.getChildren();
for (int i= 0; i < ws.length; i++) {
Control w= ws[i];
boolean skip = false;
if (w == getToolBarControl()) {
skip = true;
result.y+= BAR_SIZE;
} else if (getShortcutBar() != null && w == getShortcutBar().getControl()) {
skip = true;
}
if (!skip) {
Point e= w.computeSize(wHint, hHint, flushCache);
result.x= Math.max(result.x, e.x);
result.y+= e.y + VGAP;
}
}
result.x += BAR_SIZE; // For shortcut bar.
if (wHint != SWT.DEFAULT)
result.x= wHint;
if (hHint != SWT.DEFAULT)
result.y= hHint;
return result;
}
protected void layout(Composite composite, boolean flushCache)
{
Rectangle clientArea= composite.getClientArea();
// Loop through the children.
// Expected order == sep1, toolbar, status, sep2, shortcuts, sep3, client
Control[] ws= composite.getChildren();
for (int i= 0; i < ws.length; i++) {
Control w= ws[i];
if (i == 0) {
Point e= w.computeSize(SWT.DEFAULT, SWT.DEFAULT, flushCache);
w.setBounds(clientArea.x, clientArea.y, clientArea.width, e.y);
clientArea.y+= e.y;
clientArea.height-= e.y;
} else if (w == getSeparator2()) {
if (getShowToolBar()) {
Point e= w.computeSize(SWT.DEFAULT, SWT.DEFAULT, flushCache);
w.setBounds(clientArea.x, clientArea.y, clientArea.width, e.y);
clientArea.y+= e.y;
clientArea.height-= e.y;
}
else {
w.setBounds(0,0,0,0);
}
} else if (w == getToolBarControl()) {
if (getShowToolBar()) {
int height = BAR_SIZE;
if (toolBarChildrenExist()) {
Point e = w.computeSize(clientArea.width, SWT.DEFAULT, flushCache);
height = e.y;
}
w.setBounds(clientArea.x, clientArea.y, clientArea.width, height);
clientArea.y+= height;
clientArea.height-= height;
}
else {
w.setBounds(0,0,0,0);
}
} else if (getStatusLineManager() != null && w == getStatusLineManager().getControl()) {
if (getShowStatusLine()) {
int width = 0;
if (getShortcutBar() != null && getShowShortcutBar()) {
Widget widget = getShortcutBar().getControl();
if (widget != null) {
if (widget instanceof ToolBar) {
ToolBar bar = (ToolBar) widget;
if (bar.getItemCount() > 0) {
ToolItem item = bar.getItem(0);
width = item.getWidth();
Rectangle trim = bar.computeTrim(0,0,width,width);
width = trim.width;
}
}
}
}
Point e= w.computeSize(SWT.DEFAULT, SWT.DEFAULT, flushCache);
w.setBounds(clientArea.x + width, clientArea.y+clientArea.height-e.y, clientArea.width - width, e.y);
clientArea.height-= e.y + VGAP;
}
else {
w.setBounds(0,0,0,0);
}
} else if (getShortcutBar() != null && w == getShortcutBar().getControl()) {
if (getShowShortcutBar()) {
int width = BAR_SIZE;
if (w instanceof ToolBar) {
ToolBar bar = (ToolBar) w;
if (bar.getItemCount() > 0) {
ToolItem item = bar.getItem(0);
width = item.getWidth();
Rectangle trim = bar.computeTrim(0,0,width,width);
width = trim.width;
}
}
w.setBounds(clientArea.x, clientArea.y, width, clientArea.height);
clientArea.x+= width + VGAP;
clientArea.width-= width + VGAP;
}
else {
w.setBounds(0,0,0,0);
}
} else if (w == getSeparator3()) {
if (getShowShortcutBar()) {
Point e= w.computeSize(SWT.DEFAULT, SWT.DEFAULT, flushCache);
w.setBounds(clientArea.x, clientArea.y, e.x, clientArea.height);
clientArea.x+= e.x;
}
else {
w.setBounds(0,0,0,0);
}
} else {
// Must be client.
// Inset client area by 3 pixels
w.setBounds(clientArea.x + CLIENT_INSET, clientArea.y + CLIENT_INSET + VGAP, clientArea.width - ( 2 * CLIENT_INSET), clientArea.height - VGAP - (2 * CLIENT_INSET));
}
}
}
}
/**
* Constructs a new workbench window.
*
* @param workbench the Workbench
* @param number the number for the window
*/
public WorkbenchWindow(Workbench workbench, int number) {
super(null);
this.workbench = workbench;
this.number = number;
// Setup window.
addMenuBar();
addToolBar(SWT.FLAT);
addStatusLine();
addShortcutBar(SWT.FLAT | SWT.WRAP | SWT.VERTICAL);
updateBarVisibility();
// Add actions.
actionPresentation = new ActionPresentation(this);
actionBuilder = ((Workbench) getWorkbench()).createActionBuilder(this);
actionBuilder.buildActions();
// include the workspace location in the title
// if the command line option -showlocation is specified
String[] args = Platform.getCommandLineArgs();
for (int i = 0; i < args.length; i++) {
if ("-showlocation".equalsIgnoreCase(args[i])) { //$NON-NLS-1$
workspaceLocation = Platform.getLocation().toOSString();
break;
}
}
this.partDropListener = new IPartDropListener() {
public void dragOver(PartDropEvent e) {
WorkbenchPage page = getActiveWorkbenchPage();
Perspective persp = page.getActivePerspective();
PerspectivePresentation presentation = persp.getPresentation();
presentation.onPartDragOver(e);
};
public void drop(PartDropEvent e) {
WorkbenchPage page = getActiveWorkbenchPage();
Perspective persp = page.getActivePerspective();
PerspectivePresentation presentation = persp.getPresentation();
presentation.onPartDrop(e);
};
};
}
/*
* Adds an listener to the part service.
*/
public void addPageListener(IPageListener l) {
pageListeners.addPageListener(l);
}
/*
* Adds an listener to the perspective service.
*
* NOTE: Internally, please use getPerspectiveService instead.
*/
public void addPerspectiveListener(org.eclipse.ui.IPerspectiveListener l) {
perspectiveListeners.addPerspectiveListener(l);
}
/**
* add a shortcut for the page.
*/
/* package */ void addPerspectiveShortcut(IPerspectiveDescriptor perspective, WorkbenchPage page) {
SetPagePerspectiveAction action = new SetPagePerspectiveAction(perspective, page);
shortcutBar.appendToGroup(GRP_PERSPECTIVES, action);
shortcutBar.update(false);
}
/**
* Configures this window to have a shortcut bar.
* Does nothing if it already has one.
* This method must be called before this window's shell is created.
*/
protected void addShortcutBar(int style) {
if ((getShell() == null) && (shortcutBar == null)) {
shortcutBar = new ToolBarManager(style);
}
}
/**
* Configures this window to have a cool bar.
* This method must be called before this window's shell is created.
*/
protected void addToolBar(int style) {
if (getShell() == null)
coolBarManager = new CoolBarManager(style);
}
/**
* Close the window.
*
* Assumes that busy cursor is active.
*/
private boolean busyClose() {
// Whether the window was actually closed or not
boolean windowClosed = false;
// Setup internal flags to indicate window is in
// progress of closing and no update should be done.
closing = true;
updateDisabled = true;
try {
// Only do the check if it is OK to close if we are not closing
// via the workbench as the workbench will check this itself.
int count = workbench.getWorkbenchWindowCount();
if (count <= 1 && !workbench.isClosing()) {
windowClosed = workbench.close();
} else {
if (okToClose()) {
windowClosed = hardClose();
}
}
} finally {
if (!windowClosed) {
// Reset the internal flags if window was not closed.
closing = false;
updateDisabled = false;
}
}
return windowClosed;
}
/**
* Opens a new page. Assumes that busy cursor is active.
* <p>
* <b>Note:</b> Since release 2.0, a window is limited to contain at most
* one page. If a page exist in the window when this method is used, then
* another window is created for the new page. Callers are strongly
* recommended to use the <code>IWorkbench.openPerspective</code> APIs to
* programmatically show a perspective.
* </p>
*/
protected IWorkbenchPage busyOpenPage(String perspID, IAdaptable input)
throws WorkbenchException
{
IWorkbenchPage newPage = null;
if (pageList.isEmpty()) {
newPage = new WorkbenchPage(this, perspID, input);
pageList.add(newPage);
firePageOpened(newPage);
setActivePage(newPage);
} else {
IWorkbenchWindow window = getWorkbench().openWorkbenchWindow(perspID, input);
newPage = window.getActivePage();
}
return newPage;
}
/**
* @see Window
*/
public int open() {
int r = super.open();
workbench.fireWindowOpened(this);
return r;
}
/* (non-Javadoc)
* Method declared on Window.
*/
protected boolean canHandleShellCloseEvent() {
if (!super.canHandleShellCloseEvent())
return false;
// When closing the last window, prompt for confirmation
if (workbench.getWorkbenchWindowCount() > 1)
return true;
IPreferenceStore store = WorkbenchPlugin.getDefault().getPreferenceStore();
boolean promptOnExit = store.getBoolean(IPreferenceConstants.EXIT_PROMPT_ON_CLOSE_LAST_WINDOW);
if (promptOnExit) {
String message;
String productName = workbench.getConfigurationInfo().getAboutInfo().getProductName();
if (productName == null) {
message = WorkbenchMessages.getString("PromptOnExitDialog.message0"); //$NON-NLS-1$
} else {
message = WorkbenchMessages.format("PromptOnExitDialog.message1", new Object[] {productName}); //$NON-NLS-1$
}
MessageDialogWithToggle dlg = MessageDialogWithToggle.openConfirm(
getShell(),
WorkbenchMessages.getString("PromptOnExitDialog.shellTitle"), //$NON-NLS-1$,
message,
WorkbenchMessages.getString("PromptOnExitDialog.choice"), //$NON-NLS-1$,
false);
if (dlg.getReturnCode() == MessageDialogWithToggle.OK) {
store.setValue(IPreferenceConstants.EXIT_PROMPT_ON_CLOSE_LAST_WINDOW, !dlg.getToggleState());
return true;
} else {
return false;
}
}
return true;
}
/**
* @see IWorkbenchWindow
*/
public boolean close() {
final boolean [] ret = new boolean[1];
BusyIndicator.showWhile(null, new Runnable() {
public void run() {
ret[0] = busyClose();
}
});
return ret[0];
}
protected boolean isClosing() {
return closing || workbench.isClosing();
}
/**
* Return whether or not the coolbar layout is locked.
*/
protected boolean isToolBarLocked() {
return getCoolBarManager().isLayoutLocked();
}
/**
* Close all of the pages.
*/
private void closeAllPages()
{
// Deactivate active page.
setActivePage(null);
// Clone and deref all so that calls to getPages() returns
// empty list (if call by pageClosed event handlers)
PageList oldList = pageList;
pageList = new PageList();
// Close all.
Iterator enum = oldList.iterator();
while (enum.hasNext()) {
WorkbenchPage page = (WorkbenchPage)enum.next();
firePageClosed(page);
page.dispose();
}
if(!closing)
showEmptyWindowMessage();
}
/**
* Save and close all of the pages.
*/
public void closeAllPages(boolean save) {
if (save) {
boolean ret = saveAllPages(true);
if (!ret) return;
}
closeAllPages();
}
/**
* closePerspective method comment.
*/
protected boolean closePage(IWorkbenchPage in, boolean save) {
// Validate the input.
if (!pageList.contains(in))
return false;
WorkbenchPage oldPage = (WorkbenchPage)in;
// Save old perspective.
if (save && oldPage.isSaveNeeded()) {
if (!oldPage.saveAllEditors(true))
return false;
}
// If old page is activate deactivate.
boolean oldIsActive = (oldPage == getActiveWorkbenchPage());
if (oldIsActive)
setActivePage(null);
// Close old page.
pageList.remove(oldPage);
firePageClosed(oldPage);
oldPage.dispose();
// Activate new page.
if (oldIsActive) {
IWorkbenchPage newPage = pageList.getNextActive();
if (newPage != null)
setActivePage(newPage);
}
if(!closing && pageList.isEmpty())
showEmptyWindowMessage();
return true;
}
private void showEmptyWindowMessage() {
Composite parent = getClientComposite();
if(noOpenPerspective == null) {
noOpenPerspective = new Label(parent,SWT.NONE);
noOpenPerspective.setText(WorkbenchMessages.getString("WorkbenchWindow.noPerspective")); //$NON-NLS-1$
noOpenPerspective.setBounds(parent.getClientArea());
}
}
/**
* Sets the ApplicationWindows's content layout.
* This vertical layout supports a fixed size Toolbar area, a separator line,
* the variable size content area,
* and a fixed size status line.
*/
protected void configureShell(Shell shell) {
super.configureShell(shell);
shell.setLayout(getLayout());
shell.setSize(800, 600);
separator2 = new Label(shell, SWT.SEPARATOR | SWT.HORIZONTAL);
createShortcutBar(shell);
separator3 = new Label(shell, SWT.SEPARATOR | SWT.VERTICAL);
WorkbenchHelp.setHelp(shell, IHelpContextIds.WORKBENCH_WINDOW);
trackShellActivation(shell);
// If the user clicks on toolbar, status bar, or shortcut bar
// hide the fast view.
Listener listener = new Listener() {
public void handleEvent(Event event) {
WorkbenchPage currentPage = getActiveWorkbenchPage();
if (currentPage != null) {
if (event.type == SWT.MouseDown) {
if (event.widget instanceof ToolBar) {
// Ignore mouse down on actual tool bar buttons
Point pt = new Point(event.x, event.y);
ToolBar toolBar = (ToolBar)event.widget;
if (toolBar.getItem(pt) != null)
return;
}
currentPage.toggleFastView(null);
}
}
}
};
getToolBarControl().addListener(SWT.MouseDown, listener);
Control[] children = ((Composite)getStatusLineManager().getControl()).getChildren();
for (int i = 0; i < children.length; i++) {
if (children[i] != null)
children[i].addListener(SWT.MouseDown, listener);
}
getShortcutBar().getControl().addListener(SWT.MouseDown, listener);
}
/**
* Create the shortcut toolbar control
*/
private void createShortcutBar(Shell shell) {
// Create control.
if (shortcutBar == null)
return;
shortcutBar.createControl(shell);
// Define shortcut part. This is for drag and drop.
shortcutBarPart = new ShortcutBarPart(shortcutBar);
// Enable drag and drop.
enableDragShortcutBarPart();
// Add right mouse button support.
ToolBar tb = shortcutBar.getControl();
tb.addMouseListener(new MouseAdapter() {
public void mouseDown(MouseEvent e) {
if (e.button == 3)
showShortcutBarPopup(e);
}
});
}
/**
* Creates the control for the cool bar control.
* </p>
* @return a Control
*/
protected Control createToolBarControl(Shell shell) {
CoolBarManager manager = getCoolBarManager();
return manager.createControl(shell);
}
/**
* Do not create a toolbarmanager. WorkbenchWindow uses CoolBarManager.
* </p>
* @return a Control
*/
protected ToolBarManager createToolBarManager(int style) {
return null;
}
/* (non-Javadoc)
* Method declared on ApplicationWindow.
*/
protected MenuManager createMenuManager() {
final MenuManager result = super.createMenuManager();
result.setOverrides(new IContributionManagerOverrides() {
public Integer getAccelerator(IContributionItem contributionItem) {
if (!(contributionItem instanceof ActionContributionItem))
return null;
ActionContributionItem actionContributionItem = (ActionContributionItem) contributionItem;
String commandId = actionContributionItem.getAction().getActionDefinitionId();
if (commandId == null) {
int accelerator = actionContributionItem.getAction().getAccelerator();
if (accelerator != 0) {
Sequence keySequence = Sequence.create(Stroke.create(accelerator));
Map keySequenceMapForMode = Manager.getInstance().getKeyMachine().getSequenceMapForMode();
if (keySequenceMapForMode.get(keySequence) == null)
return null;
}
} else if ("carbon".equals(SWT.getPlatform())) { //$NON-NLS-1$
Map commandMap = Manager.getInstance().getKeyMachine().getCommandMap();
SortedSet keySequenceSet = (SortedSet) commandMap.get(commandId);
if (keySequenceSet != null && !keySequenceSet.isEmpty()) {
Sequence keySequence = (Sequence) keySequenceSet.first();
List keyStrokes = keySequence.getStrokes();
if (keyStrokes.size() == 1) {
Stroke keyStroke = (Stroke) keyStrokes.get(0);
return new Integer(keyStroke.getValue());
}
}
}
return new Integer(0);
}
public String getAcceleratorText(IContributionItem contributionItem) {
if (!(contributionItem instanceof ActionContributionItem))
return null;
ActionContributionItem actionContributionItem = (ActionContributionItem) contributionItem;
String commandId = actionContributionItem.getAction().getActionDefinitionId();
if (commandId == null) {
int accelerator = actionContributionItem.getAction().getAccelerator();
if (accelerator != 0) {
Sequence keySequence = Sequence.create(Stroke.create(accelerator));
Map keySequenceMapForMode = Manager.getInstance().getKeyMachine().getSequenceMapForMode();
if (keySequenceMapForMode.get(keySequence) == null)
return null;
}
} else if ("carbon".equals(SWT.getPlatform())) { //$NON-NLS-1$
Map commandMap = Manager.getInstance().getKeyMachine().getCommandMap();
SortedSet keySequenceSet = (SortedSet) commandMap.get(commandId);
if (keySequenceSet != null && !keySequenceSet.isEmpty()) {
Sequence keySequence = (Sequence) keySequenceSet.first();
List keyStrokes = keySequence.getStrokes();
StringBuffer stringBuffer = new StringBuffer();
for (int i = 0; i < keyStrokes.size(); i++) {
if (i >= 1)
stringBuffer.append(' ');
Stroke keyStroke = (Stroke) keyStrokes.get(i);
int value = keyStroke.getValue();
if ((value & SWT.SHIFT) != 0)
stringBuffer.append('\u21E7');
if ((value & SWT.CTRL) != 0)
stringBuffer.append('\u2303');
if ((value & SWT.ALT) != 0)
stringBuffer.append('\u2325');
if ((value & SWT.COMMAND) != 0)
stringBuffer.append('\u2318');
stringBuffer.append(Action.findKeyString(value));
}
return stringBuffer.toString();
}
} else {
String acceleratorText = Manager.getInstance().getKeyTextForCommand(commandId);
if (acceleratorText != null)
return acceleratorText;
}
return ""; //$NON-NLS-1$
}
public String getText(IContributionItem contributionItem) {
if (!(contributionItem instanceof MenuManager))
return null;
MenuManager menuManager = (MenuManager) contributionItem;
IContributionManager parent = menuManager.getParent();
if (parent != result) {
if (parent instanceof SubMenuManager) {
parent = ((SubMenuManager) parent).getParent();
if (parent != result)
return null;
} else
return null;
}
String text = menuManager.getMenuText();
int index = text.indexOf('&');
if (index < 0 || index == (text.length() - 1))
return text;
char altChar = Character.toUpperCase(text.charAt(index + 1));
Manager manager = Manager.getInstance();
SequenceMachine keyMachine = manager.getKeyMachine();
Sequence mode = keyMachine.getMode();
List strokes = new ArrayList(mode.getStrokes());
strokes.add(Stroke.create(SWT.ALT | altChar));
Sequence childMode = Sequence.create(strokes);
Map sequenceMapForMode = keyMachine.getSequenceMapForMode();
String commandId = (String) sequenceMapForMode.get(childMode);
if (commandId == null)
return text;
if (index == 0)
return text.substring(1);
return text.substring(0, index) + text.substring(index + 1);
}
public Boolean getEnabled(IContributionItem item) {
return null;
}
});
return result;
}
/**
* Enables fast view icons to be dragged and dropped using the given IPartDropListener.
*/
/*package*/ void enableDragShortcutBarPart() {
Control control = shortcutBarPart.getControl();
if (control != null && shortcutDND == null) {
// Only one ShortcutBarPartDragDrop per WorkbenchWindow.
shortcutDND = new ShortcutBarPartDragDrop(shortcutBarPart, control);
// Add the listener only once.
shortcutDND.addDropListener(partDropListener);
}
}
/**
* Returns the shortcut for a page.
*/
/* protected */ IContributionItem findPerspectiveShortcut(IPerspectiveDescriptor perspective, WorkbenchPage page) {
IContributionItem[] array = shortcutBar.getItems();
int length = array.length;
for (int i = 0; i < length; i++) {
IContributionItem item = array[i];
if (item instanceof ActionContributionItem) {
IAction action = ((ActionContributionItem)item).getAction();
if (action instanceof SetPagePerspectiveAction) {
SetPagePerspectiveAction sp = (SetPagePerspectiveAction)action;
if (sp.handles(perspective, page))
return item;
}
}
}
return null;
}
/**
* Fires page activated
*/
private void firePageActivated(IWorkbenchPage page) {
pageListeners.firePageActivated(page);
partService.pageActivated(page);
}
/**
* Fires page closed
*/
private void firePageClosed(IWorkbenchPage page) {
pageListeners.firePageClosed(page);
partService.pageClosed(page);
}
/**
* Fires page opened
*/
private void firePageOpened(IWorkbenchPage page) {
pageListeners.firePageOpened(page);
partService.pageOpened(page);
}
/**
* Fires perspective activated
*/
void firePerspectiveActivated(IWorkbenchPage page, IPerspectiveDescriptor perspective) {
perspectiveListeners.firePerspectiveActivated(page, perspective);
perspectiveService.firePerspectiveActivated(page, perspective);
}
/**
* Fires perspective changed
*/
void firePerspectiveChanged(IWorkbenchPage page, IPerspectiveDescriptor perspective, String changeId) {
perspectiveListeners.firePerspectiveChanged(page, perspective, changeId);
perspectiveService.firePerspectiveChanged(page, perspective, changeId);
}
/**
* Fires perspective closed
*/
void firePerspectiveClosed(IWorkbenchPage page, IPerspectiveDescriptor perspective) {
perspectiveService.firePerspectiveClosed(page, perspective);
}
/**
* Fires perspective opened
*/
void firePerspectiveOpened(IWorkbenchPage page, IPerspectiveDescriptor perspective) {
perspectiveService.firePerspectiveOpened(page, perspective);
}
/**
* Returns the action bars for this window.
*/
public IActionBars getActionBars() {
if (actionBars == null) {
actionBars = new WWinActionBars(this);
}
return actionBars;
}
/**
* Returns the action builder for this window.
*/
/*package*/ final WorkbenchActionBuilder getActionBuilder() {
return actionBuilder;
}
/**
* Returns the active page.
*
* @return the active page
*/
public IWorkbenchPage getActivePage() {
return pageList.getActive();
}
/**
* Returns the active workbench page.
*
* @return the active workbench page
*/
/* package */ WorkbenchPage getActiveWorkbenchPage() {
return pageList.getActive();
}
/**
* Returns cool bar control for the window. Overridden
* to support CoolBars.
* </p>
* @return a Control
*/
protected CoolBar getCoolBarControl() {
return getCoolBarManager().getControl();
}
/**
* Returns the CoolBarManager for this window.
*
* @return theCoolBarManager, or <code>null</code> if
* this window does not have a CoolBar.
* @see #addCoolBar
*/
public CoolBarManager getCoolBarManager() {
return coolBarManager;
}
/**
* Get the workbench client area.
*/
protected Composite getClientComposite() {
return (Composite)getContents();
}
/**
* Answer the menu manager for this window.
*/
public MenuManager getMenuManager() {
return getMenuBarManager();
}
/**
* Returns the number. This corresponds to a page number in a window or a
* window number in the workbench.
*/
public int getNumber() {
return number;
}
/**
* Returns an array of the pages in the workbench window.
*
* @return an array of pages
*/
public IWorkbenchPage[] getPages() {
return pageList.getPages();
}
/**
* @see IWorkbenchWindow
*/
public IPartService getPartService() {
return partService;
}
/**
* Returns the key binding service in use.
*
* @return the key binding service in use.
* @since 2.0
*/
public WWinKeyBindingService getKeyBindingService() {
if (keyBindingService == null) {
keyBindingService = new WWinKeyBindingService(this);
updateActiveActions();
}
return keyBindingService;
}
/**
* Re-register the action sets actions in the keybinding service.
*/
private void updateActiveActions() {
if(keyBindingService == null) {
getKeyBindingService();
} else {
IActionSet sets[] = actionPresentation.getActionSets();
keyBindingService.registerActionSets(sets);
}
}
/**
* Returns the layout for the shell.
*
* @return the layout for the shell
*/
protected Layout getLayout() {
return new WorkbenchWindowLayout();
}
/**
* @see IWorkbenchWindow
*/
public IPerspectiveService getPerspectiveService() {
return perspectiveService;
}
/**
* Returns the separator2 control.
*/
protected Label getSeparator2() {
return separator2;
}
/**
* Returns the separator3 control.
*/
protected Label getSeparator3() {
return separator3;
}
/**
* @see IWorkbenchWindow
*/
public ISelectionService getSelectionService() {
return partService.getSelectionService();
}
/**
* Returns <code>true</code> when the window's shell
* is activated, <code>false</code> when it's shell is
* deactivated
*
* @return boolean <code>true</code> when shell activated,
* <code>false</code> when shell deactivated
*/
public boolean getShellActivated() {
return shellActivated;
}
/**
* Returns the shortcut bar.
*/
public ToolBarManager getShortcutBar() {
return shortcutBar;
}
/**
* Returns the PartDragDrop for the shortcut bar part.
*/
/*package*/ShortcutBarPartDragDrop getShortcutDND() {
return shortcutDND;
}
/**
* Returns whether the shortcut bar should be shown.
*
* @return <code>true</code> to show it, <code>false</code> to hide it
*/
public boolean getShowShortcutBar() {
return showShortcutBar;
}
/**
* Returns whether the status bar should be shown.
*
* @return <code>true</code> to show it, <code>false</code> to hide it
*/
public boolean getShowStatusLine() {
return showStatusLine;
}
/**
* Returns whether the tool bar should be shown.
*
* @return <code>true</code> to show it, <code>false</code> to hide it
*/
public boolean getShowToolBar() {
return showToolBar;
}
/**
* Returns the status line manager for this window (if it has one).
*
* @return the status line manager, or <code>null</code> if
* this window does not have a status line
* @see #addStatusLine
*/
protected StatusLineManager getStatusLineManager() {
return super.getStatusLineManager();
}
/**
* Returns tool bar control for the window. Overridden
* to support CoolBars.
* </p>
* @return a Control
*/
protected Control getToolBarControl() {
return getCoolBarControl();
}
/**
* WorkbenchWindow uses CoolBarManager, so return null here.
* </p>
* @return a Control
*/
public ToolBarManager getToolBarManager() {
return null;
}
/**
* @see IWorkbenchWindow
*/
public IWorkbench getWorkbench() {
return workbench;
}
/**
* Unconditionally close this window. Assumes the proper
* flags have been set correctly (e.i. closing and updateDisabled)
*/
private boolean hardClose() {
try {
// Clear the action sets, fix for bug 27416.
actionPresentation.clearActionSets();
closeAllPages();
actionBuilder.dispose();
workbench.fireWindowClosed(this);
} finally {
return super.close();
}
}
/**
* @see IWorkbenchWindow
*/
public boolean isApplicationMenu(String menuID) {
return actionBuilder.isContainerMenu(menuID);
}
/**
* Return whether or not given id matches the id of the coolitems that
* the workbench creates.
*/
/* package */ boolean isWorkbenchCoolItemId(String id) {
return actionBuilder.isWorkbenchCoolItemId(id);
}
/**
* Locks/unlocks the CoolBar for the workbench.
*
* @param lock whether the CoolBar should be locked or unlocked
*/
/* package */ void lockToolBar(boolean lock) {
getCoolBarManager().lockLayout(lock);
}
/**
* Called when this window is about to be closed.
*
* Subclasses may overide to add code that returns <code>false</code>
* to prevent closing under certain conditions.
*/
public boolean okToClose() {
// Save all of the editors.
if(!workbench.isClosing())
if (!saveAllPages(true))
return false;
return true;
}
/**
* Opens a new page.
* <p>
* <b>Note:</b> Since release 2.0, a window is limited to contain at most
* one page. If a page exist in the window when this method is used, then
* another window is created for the new page. Callers are strongly
* recommended to use the <code>IWorkbench.openPerspective</code> APIs to
* programmatically show a perspective.
* </p>
*/
public IWorkbenchPage openPage(final String perspId, final IAdaptable input)
throws WorkbenchException
{
Assert.isNotNull(perspId);
// Run op in busy cursor.
final Object [] result = new Object[1];
BusyIndicator.showWhile(null, new Runnable() {
public void run() {
try {
result[0] = busyOpenPage(perspId, input);
} catch (WorkbenchException e) {
result[0] = e;
}
}
});
if (result[0] instanceof IWorkbenchPage)
return (IWorkbenchPage)result[0];
else if (result[0] instanceof WorkbenchException)
throw (WorkbenchException)result[0];
else
throw new WorkbenchException(WorkbenchMessages.getString("WorkbenchWindow.exceptionMessage")); //$NON-NLS-1$
}
/**
* Opens a new page.
* <p>
* <b>Note:</b> Since release 2.0, a window is limited to contain at most
* one page. If a page exist in the window when this method is used, then
* another window is created for the new page. Callers are strongly
* recommended to use the <code>IWorkbench.openPerspective</code> APIs to
* programmatically show a perspective.
* </p>
*/
public IWorkbenchPage openPage(IAdaptable input)
throws WorkbenchException
{
String perspId = workbench.getPerspectiveRegistry().getDefaultPerspective();
return openPage(perspId, input);
}
/*
* Removes an listener from the part service.
*/
public void removePageListener(IPageListener l) {
pageListeners.removePageListener(l);
}
/*
* Removes an listener from the perspective service.
*
* NOTE: Internally, please use getPerspectiveService instead.
*/
public void removePerspectiveListener(org.eclipse.ui.IPerspectiveListener l) {
perspectiveListeners.removePerspectiveListener(l);
}
/**
* Remove the shortcut for a page.
*/
/* package */ void removePerspectiveShortcut(IPerspectiveDescriptor perspective, WorkbenchPage page) {
IContributionItem item = findPerspectiveShortcut(perspective, page);
if (item != null) {
shortcutBar.remove(item);
shortcutBar.update(false);
}
}
private IStatus unableToRestorePage(IMemento pageMem) {
String pageName = pageMem.getString(IWorkbenchConstants.TAG_LABEL);
if(pageName == null)
pageName = ""; //$NON-NLS-1$
return new Status(
IStatus.ERROR,PlatformUI.PLUGIN_ID,0,
WorkbenchMessages.format("WorkbenchWindow.unableToRestorePerspective",new String[]{pageName}), //$NON-NLS-1$
null);
}
/**
* @see IPersistable.
*/
public IStatus restoreState(IMemento memento, IPerspectiveDescriptor activeDescriptor) {
Assert.isNotNull(getShell());
MultiStatus result = new MultiStatus(
PlatformUI.PLUGIN_ID,IStatus.OK,
WorkbenchMessages.getString("WorkbenchWindow.problemsRestoringWindow"),null); //$NON-NLS-1$
// Read the bounds.
if("true".equals(memento.getString("maximized"))) {//$NON-NLS-2$//$NON-NLS-1$
getShell().setMaximized(true);
} else if ("true".equals(memento.getString("minimized"))) { //$NON-NLS-1$ //$NON-NLS-2$
//Do not restore minimized state.
} else {
Integer bigInt;
bigInt = memento.getInteger(IWorkbenchConstants.TAG_X);
int x = bigInt.intValue();
bigInt = memento.getInteger(IWorkbenchConstants.TAG_Y);
int y = bigInt.intValue();
bigInt = memento.getInteger(IWorkbenchConstants.TAG_WIDTH);
int width = bigInt.intValue();
bigInt = memento.getInteger(IWorkbenchConstants.TAG_HEIGHT);
int height = bigInt.intValue();
// Set the bounds.
getShell().setBounds(x, y, width, height);
}
// Recreate toolbar layout locked state.
Integer locked = memento.getInteger(IWorkbenchConstants.TAG_TOOLBAR_LAYOUT);
boolean state = (locked != null) && (locked.intValue() == 1);
lockToolBar(state);
// Recreate each page in the window.
IWorkbenchPage newActivePage = null;
IMemento [] pageArray = memento.getChildren(IWorkbenchConstants.TAG_PAGE);
for (int i = 0; i < pageArray.length; i ++) {
IMemento pageMem = pageArray[i];
String strFocus = pageMem.getString(IWorkbenchConstants.TAG_FOCUS);
if (strFocus == null || strFocus.length() == 0)
continue;
// Get the input factory.
IMemento inputMem = pageMem.getChild(IWorkbenchConstants.TAG_INPUT);
String factoryID = inputMem.getString(IWorkbenchConstants.TAG_FACTORY_ID);
if (factoryID == null) {
WorkbenchPlugin.log("Unable to restore page - no input factory ID.");//$NON-NLS-1$
result.add(unableToRestorePage(pageMem));
continue;
}
IAdaptable input;
try {
UIStats.start(UIStats.RESTORE_WORKBENCH,"WorkbenchPageFactory"); //$NON-NLS-1$
IElementFactory factory = WorkbenchPlugin.getDefault().getElementFactory(factoryID);
if (factory == null) {
WorkbenchPlugin.log("Unable to restore pagee - cannot instantiate input factory: " + factoryID);//$NON-NLS-1$
result.add(unableToRestorePage(pageMem));
continue;
}
// Get the input element.
input = factory.createElement(inputMem);
if (input == null) {
WorkbenchPlugin.log("Unable to restore page - cannot instantiate input element: " + factoryID);//$NON-NLS-1$
result.add(unableToRestorePage(pageMem));
continue;
}
} finally {
UIStats.end(UIStats.RESTORE_WORKBENCH,"WorkbenchPageFactory"); //$NON-NLS-1$
}
// Open the perspective.
WorkbenchPage newPage = null;
try {
newPage = new WorkbenchPage(this, input);
result.add(newPage.restoreState(pageMem,activeDescriptor));
pageList.add(newPage);
firePageOpened(newPage);
} catch (WorkbenchException e) {
WorkbenchPlugin.log("Unable to restore perspective - constructor failed.");//$NON-NLS-1$
result.add(e.getStatus());
continue;
}
if (strFocus != null && strFocus.length() > 0)
newActivePage = newPage;
}
// If there are no pages create a default.
if (pageList.isEmpty()) {
try {
IContainer root = WorkbenchPlugin.getPluginWorkspace().getRoot();
String defPerspID = workbench.getPerspectiveRegistry().getDefaultPerspective();
WorkbenchPage newPage = new WorkbenchPage(this, defPerspID, root);
pageList.add(newPage);
firePageOpened(newPage);
} catch (WorkbenchException e) {
WorkbenchPlugin.log("Unable to create default perspective - constructor failed.");//$NON-NLS-1$
result.add(e.getStatus());
String productName = workbench.getConfigurationInfo().getAboutInfo().getProductName();
if (productName == null) {
productName = ""; //$NON-NLS-1$
}
getShell().setText(productName);
}
}
// Set active page.
if (newActivePage == null)
newActivePage = (IWorkbenchPage)pageList.getNextActive();
setActivePage(newActivePage);
IWorkbenchPart part = newActivePage.getActivePart();
if (part != null)
getKeyBindingService().update(part);
return result;
}
/* (non-Javadoc)
* Method declared on IRunnableContext.
*/
public void run(boolean fork, boolean cancelable, IRunnableWithProgress runnable) throws InvocationTargetException, InterruptedException {
ToolBarManager shortcutBar = getShortcutBar();
Control shortcutBarControl = null;
if (shortcutBar != null)
shortcutBarControl = shortcutBar.getControl();
boolean shortcutbarWasEnabled = false;
if (shortcutBarControl != null)
shortcutbarWasEnabled = shortcutBarControl.isEnabled();
try {
if (shortcutBarControl != null && !shortcutBarControl.isDisposed())
shortcutBarControl.setEnabled(false);
super.run(fork, cancelable, runnable);
} finally {
if (shortcutBarControl != null && !shortcutBarControl.isDisposed())
shortcutBarControl.setEnabled(shortcutbarWasEnabled);
}
}
/**
* Save all of the pages. Returns true if the operation succeeded.
*/
private boolean saveAllPages(boolean bConfirm)
{
boolean bRet = true;
Iterator enum = pageList.iterator();
while (bRet && enum.hasNext()) {
WorkbenchPage page = (WorkbenchPage)enum.next();
bRet = page.saveAllEditors(bConfirm);
}
return bRet;
}
/**
* @see IPersistable
*/
public IStatus saveState(IMemento memento) {
MultiStatus result = new MultiStatus(
PlatformUI.PLUGIN_ID,IStatus.OK,
WorkbenchMessages.getString("WorkbenchWindow.problemsSavingWindow"),null); //$NON-NLS-1$
// Save the bounds.
if(getShell().getMaximized()) {
memento.putString("maximized","true");//$NON-NLS-2$//$NON-NLS-1$
} else if(getShell().getMinimized()) {
memento.putString("minimized","true");//$NON-NLS-2$//$NON-NLS-1$
} else {
Rectangle bounds = getShell().getBounds();
memento.putInteger(IWorkbenchConstants.TAG_X, bounds.x);
memento.putInteger(IWorkbenchConstants.TAG_Y, bounds.y);
memento.putInteger(IWorkbenchConstants.TAG_WIDTH, bounds.width);
memento.putInteger(IWorkbenchConstants.TAG_HEIGHT, bounds.height);
}
// Save toolbar lock state.
int state = isToolBarLocked() ? 1 : 0;
memento.putInteger(IWorkbenchConstants.TAG_TOOLBAR_LAYOUT, state);
// Save each page.
Iterator enum = pageList.iterator();
while (enum.hasNext()) {
WorkbenchPage page = (WorkbenchPage)enum.next();
// Get the input.
IAdaptable input = page.getInput();
if (input == null) {
WorkbenchPlugin.log("Unable to save page input: " + page);//$NON-NLS-1$
continue;
}
IPersistableElement persistable = (IPersistableElement)input.getAdapter(IPersistableElement.class);
if (persistable == null) {
WorkbenchPlugin.log("Unable to save page input: " + input);//$NON-NLS-1$
continue;
}
// Save perspective.
IMemento pageMem = memento.createChild(IWorkbenchConstants.TAG_PAGE);
pageMem.putString(IWorkbenchConstants.TAG_LABEL,page.getLabel());
result.add(page.saveState(pageMem));
if (page == getActiveWorkbenchPage()) {
pageMem.putString(IWorkbenchConstants.TAG_FOCUS, "true");//$NON-NLS-1$
}
// Save input.
IMemento inputMem = pageMem.createChild(IWorkbenchConstants.TAG_INPUT);
inputMem.putString(IWorkbenchConstants.TAG_FACTORY_ID, persistable.getFactoryId());
persistable.saveState(inputMem);
}
return result;
}
/**
* Select the shortcut for a perspective.
*/
/* package */ void selectPerspectiveShortcut(IPerspectiveDescriptor perspective, WorkbenchPage page, boolean selected) {
IContributionItem item = findPerspectiveShortcut(perspective, page);
if (item != null) {
IAction action = ((ActionContributionItem)item).getAction();
action.setChecked(selected);
}
}
/**
* Sets the active page within the window.
*
* @param page identifies the new active page.
*/
public void setActivePage(final IWorkbenchPage in) {
if (getActiveWorkbenchPage() == in)
return;
// 1FVGTNR: ITPUI:WINNT - busy cursor for switching perspectives
BusyIndicator.showWhile(getShell().getDisplay(), new Runnable() {
public void run() {
// Deactivate old persp.
WorkbenchPage currentPage = getActiveWorkbenchPage();
if (currentPage != null) {
currentPage.onDeactivate();
}
// Activate new persp.
if (in == null || pageList.contains(in))
pageList.setActive(in);
WorkbenchPage newPage = pageList.getActive();
if (newPage != null) {
newPage.onActivate();
firePageActivated(newPage);
if (newPage.getPerspective() != null)
firePerspectiveActivated(newPage, newPage.getPerspective());
}
if(isClosing())
return;
updateDisabled = false;
// Update action bars ( implicitly calls updateActionBars() )
updateTitle();
updateActionSets();
shortcutBar.update(false);
if (newPage != null && newPage.getPerspective() != null)
newPage.setToolBarLayout();
getMenuManager().update(IAction.TEXT);
if(noOpenPerspective != null && in != null) {
noOpenPerspective.dispose();
noOpenPerspective = null;
}
}
});
}
/**
* Sets whether the shortcut bar should be visible.
*
* @param show <code>true</code> to show it, <code>false</code> to hide it
*/
public void setShowShortcutBar(boolean show) {
showShortcutBar = show;
}
/**
* Sets whether the status line should be visible.
*
* @param show <code>true</code> to show it, <code>false</code> to hide it
*/
public void setShowStatusLine (boolean show) {
showStatusLine = show;
}
/**
* Sets whether the tool bar should be visible.
*
* @param show <code>true</code> to show it, <code>false</code> to hide it
*/
public void setShowToolBar(boolean show) {
showToolBar = show;
}
/**
* Shows the popup menu for a page item in the shortcut bar.
*/
private void showShortcutBarPopup(MouseEvent e) {
// Get the tool item under the mouse.
Point pt = new Point(e.x, e.y);
ToolBar toolBar = shortcutBar.getControl();
ToolItem toolItem = toolBar.getItem(pt);
if (toolItem == null)
return;
// Get the action for the tool item.
Object data = toolItem.getData();
// If the tool item is an icon for a fast view
if (data instanceof ShowFastViewContribution) {
// The fast view bar menu is created lazily here.
if (fastViewBarMenu == null) {
Menu menu = new Menu(toolBar);
MenuItem closeItem = new MenuItem(menu, SWT.NONE);
closeItem.setText(WorkbenchMessages.getString("WorkbenchWindow.close")); //$NON-NLS-1$
closeItem.addSelectionListener(new SelectionAdapter() {
public void widgetSelected(SelectionEvent e) {
ToolItem toolItem = (ToolItem) fastViewBarMenu.getData();
if (toolItem != null && !toolItem.isDisposed()) {
IViewReference ref = (IViewReference)toolItem.getData(ShowFastViewContribution.FAST_VIEW);
getActiveWorkbenchPage().hideView(ref);
}
}
});
restoreItem = new MenuItem(menu, SWT.CHECK);
restoreItem.setText(WorkbenchMessages.getString("WorkbenchWindow.restore")); //$NON-NLS-1$
restoreItem.addSelectionListener(new SelectionAdapter() {
public void widgetSelected(SelectionEvent e) {
ToolItem toolItem = (ToolItem) fastViewBarMenu.getData();
if (toolItem != null && !toolItem.isDisposed()) {
IViewReference ref = (IViewReference)toolItem.getData(ShowFastViewContribution.FAST_VIEW);
getActiveWorkbenchPage().removeFastView(ref);
}
}
});
fastViewBarMenu = menu;
}
restoreItem.setSelection(true);
fastViewBarMenu.setData(toolItem);
// Show popup menu.
if (fastViewBarMenu != null) {
pt = toolBar.toDisplay(pt);
fastViewBarMenu.setLocation(pt.x, pt.y);
fastViewBarMenu.setVisible(true);
}
}
if (!(data instanceof ActionContributionItem))
return;
IAction action = ((ActionContributionItem) data).getAction();
// The tool item is an icon for a perspective.
if (action instanceof SetPagePerspectiveAction) {
// The perspective bar menu is created lazily here.
// Its data is set (each time) to the tool item, which refers to the SetPagePerspectiveAction
// which in turn refers to the page and perspective.
// It is important not to refer to the action, the page or the perspective directly
// since otherwise the menu hangs on to them after they are closed.
// By hanging onto the tool item instead, these references are cleared when the
// corresponding page or perspective is closed.
// See bug 11282 for more details on why it is done this way.
if (perspectiveBarMenu == null) {
Menu menu = new Menu(toolBar);
MenuItem menuItem = new MenuItem(menu, SWT.NONE);
menuItem.setText(WorkbenchMessages.getString("WorkbenchWindow.close")); //$NON-NLS-1$
menuItem.addSelectionListener(new SelectionAdapter() {
public void widgetSelected(SelectionEvent e) {
ToolItem toolItem = (ToolItem) perspectiveBarMenu.getData();
if (toolItem != null && !toolItem.isDisposed()) {
ActionContributionItem item = (ActionContributionItem) toolItem.getData();
SetPagePerspectiveAction action = (SetPagePerspectiveAction) item.getAction();
action.getPage().closePerspective(action.getPerspective(), true);
}
}
});
menuItem = new MenuItem(menu, SWT.NONE);
menuItem.setText(WorkbenchMessages.getString("WorkbenchWindow.closeAll")); //$NON-NLS-1$
menuItem.addSelectionListener(new SelectionAdapter() {
public void widgetSelected(SelectionEvent e) {
ToolItem toolItem = (ToolItem) perspectiveBarMenu.getData();
if (toolItem != null && !toolItem.isDisposed()) {
ActionContributionItem item = (ActionContributionItem) toolItem.getData();
SetPagePerspectiveAction action = (SetPagePerspectiveAction) item.getAction();
action.getPage().closeAllPerspectives();
}
}
});
perspectiveBarMenu = menu;
}
perspectiveBarMenu.setData(toolItem);
// Show popup menu.
if (perspectiveBarMenu != null) {
pt = toolBar.toDisplay(pt);
perspectiveBarMenu.setLocation(pt.x, pt.y);
perspectiveBarMenu.setVisible(true);
}
}
}
/**
* Returns whether or not children exist for the Window's toolbar control.
* Overridden for coolbar support.
* <p>
* @return boolean true if children exist, false otherwise
*/
protected boolean toolBarChildrenExist() {
CoolBar coolBarControl = getCoolBarControl();
return coolBarControl.getItemCount() > 0;
}
/**
* Hooks a listener to track the activation and
* deactivation of the window's shell. Notifies
* the active part and editor of the change
*/
private void trackShellActivation(Shell shell) {
shell.addShellListener(new ShellAdapter() {
public void shellActivated(ShellEvent event) {
shellActivated = true;
workbench.setActivatedWindow(WorkbenchWindow.this);
WorkbenchPage currentPage = getActiveWorkbenchPage();
if (currentPage != null) {
IWorkbenchPart part = currentPage.getActivePart();
if (part != null) {
PartSite site = (PartSite) part.getSite();
site.getPane().shellActivated();
}
IEditorPart editor = currentPage.getActiveEditor();
if (editor != null) {
PartSite site = (PartSite) editor.getSite();
site.getPane().shellActivated();
}
workbench.fireWindowActivated(WorkbenchWindow.this);
}
}
public void shellDeactivated(ShellEvent event) {
shellActivated = false;
WorkbenchPage currentPage = getActiveWorkbenchPage();
if (currentPage != null) {
IWorkbenchPart part = currentPage.getActivePart();
if (part != null) {
PartSite site = (PartSite) part.getSite();
site.getPane().shellDeactivated();
}
IEditorPart editor = currentPage.getActiveEditor();
if (editor != null) {
PartSite site = (PartSite) editor.getSite();
site.getPane().shellDeactivated();
}
workbench.fireWindowDeactivated(WorkbenchWindow.this);
}
}
});
}
/**
* update the action bars.
*/
public void updateActionBars() {
if (updateDisabled)
return;
// updateAll required in order to enable accelerators on pull-down menus
getMenuBarManager().updateAll(false);
getCoolBarManager().update(false);
getStatusLineManager().update(false);
}
/**
* Update the visible action sets. This method is typically called
* from a page when the user changes the visible action sets
* within the prespective.
*/
public void updateActionSets() {
if (updateDisabled)
return;
WorkbenchPage currentPage = getActiveWorkbenchPage();
if (currentPage == null)
actionPresentation.clearActionSets();
else
actionPresentation.setActionSets(currentPage.getActionSets());
updateActionBars();
// hide the launch menu if it is empty
String path = IWorkbenchActionConstants.M_WINDOW + IWorkbenchActionConstants.SEP + IWorkbenchActionConstants.M_LAUNCH;
IMenuManager manager = getMenuBarManager().findMenuUsingPath(path);
IContributionItem item = getMenuBarManager().findUsingPath(path);
updateActiveActions();
if (manager == null || item == null)
return;
item.setVisible(manager.getItems().length >= 2); // there is a separator for the additions group thus >= 2
}
/**
* Updates the shorcut item
*/
/* package */ void updatePerspectiveShortcut(IPerspectiveDescriptor oldDesc, IPerspectiveDescriptor newDesc, WorkbenchPage page) {
if(updateDisabled)
return;
IContributionItem item = findPerspectiveShortcut(oldDesc, page);
if (item != null) {
SetPagePerspectiveAction action = (SetPagePerspectiveAction)((ActionContributionItem)item).getAction();
action.update(newDesc);
if (page == getActiveWorkbenchPage())
updateTitle();
}
}
/**
* Updates the visibility of the shortcut bar, status line, and toolbar.
* Does not cause the shell to relayout.
*/
public void updateBarVisibility() {
IPreferenceStore store = WorkbenchPlugin.getDefault().getPreferenceStore();
setShowShortcutBar(store.getBoolean(IPreferenceConstants.SHOW_SHORTCUT_BAR));
setShowStatusLine(store.getBoolean(IPreferenceConstants.SHOW_STATUS_LINE));
setShowToolBar(store.getBoolean(IPreferenceConstants.SHOW_TOOL_BAR));
}
/**
* Updates the window title.
*/
public void updateTitle() {
if(updateDisabled)
return;
/*
* [pageInput -] [currentPerspective -] [editorInput -] [workspaceLocation -] productName
*/
String title = workbench.getConfigurationInfo().getAboutInfo().getProductName();
if (title == null) {
title = ""; //$NON-NLS-1$
}
if (workspaceLocation != null)
title = WorkbenchMessages.format("WorkbenchWindow.shellTitle", new Object[] {workspaceLocation,title}); //$NON-NLS-1$
WorkbenchPage currentPage = getActiveWorkbenchPage();
if (currentPage != null) {
IEditorPart editor = currentPage.getActiveEditor();
if(editor != null) {
String editorTitle = editor.getTitle();
title = WorkbenchMessages.format("WorkbenchWindow.shellTitle", new Object[] {editorTitle, title}); //$NON-NLS-1$
}
IPerspectiveDescriptor persp = currentPage.getPerspective();
String label = ""; //$NON-NLS-1$
if (persp != null)
label = persp.getLabel();
IAdaptable input = currentPage.getInput();
if((input != null) && (!input.equals(ResourcesPlugin.getWorkspace().getRoot())))
label = currentPage.getLabel();
if (label != null && !label.equals("")) //$NON-NLS-1$
title = WorkbenchMessages.format("WorkbenchWindow.shellTitle", new Object[] {label, title}); //$NON-NLS-1$
}
getShell().setText(title);
}
class PageList {
//List of pages in the order they were created;
private List pageList;
//List of pages where the top is the last activated.
private List pageStack;
// The page explicitly activated
private Object active;
public PageList() {
pageList = new ArrayList(4);
pageStack = new ArrayList(4);
}
public boolean add(Object object) {
pageList.add(object);
pageStack.add(0,object); //It will be moved to top only when activated.
return true;
}
public Iterator iterator() {
return pageList.iterator();
}
public boolean contains(Object object) {
return pageList.contains(object);
}
public boolean remove(Object object) {
if (active == object)
active = null;
pageStack.remove(object);
return pageList.remove(object);
}
public boolean isEmpty() {
return pageList.isEmpty();
}
public IWorkbenchPage[] getPages() {
int nSize = pageList.size();
IWorkbenchPage [] retArray = new IWorkbenchPage[nSize];
pageList.toArray(retArray);
return retArray;
}
public void setActive(Object page) {
if (active == page)
return;
active = page;
if (page != null) {
pageStack.remove(page);
pageStack.add(page);
}
}
public WorkbenchPage getActive() {
return (WorkbenchPage) active;
}
public WorkbenchPage getNextActive() {
if (active == null) {
if (pageStack.isEmpty())
return null;
else
return (WorkbenchPage)pageStack.get(pageStack.size() - 1);
} else {
if (pageStack.size() < 2)
return null;
else
return (WorkbenchPage)pageStack.get(pageStack.size() - 2);
}
}
}
}