001: /*******************************************************************************
002: * Copyright (c) 2000, 2007 IBM Corporation and others.
003: * All rights reserved. This program and the accompanying materials
004: * are made available under the terms of the Eclipse Public License v1.0
005: * which accompanies this distribution, and is available at
006: * http://www.eclipse.org/legal/epl-v10.html
007: *
008: * Contributors:
009: * IBM Corporation - initial API and implementation
010: *******************************************************************************/package org.eclipse.ui.actions;
011:
012: import org.eclipse.core.runtime.IAdaptable;
013: import org.eclipse.jface.action.IMenuManager;
014: import org.eclipse.swt.events.SelectionEvent;
015: import org.eclipse.ui.IPerspectiveDescriptor;
016: import org.eclipse.ui.IWorkbenchPreferenceConstants;
017: import org.eclipse.ui.IWorkbenchWindow;
018: import org.eclipse.ui.WorkbenchException;
019: import org.eclipse.ui.internal.WorkbenchMessages;
020: import org.eclipse.ui.internal.misc.StatusUtil;
021: import org.eclipse.ui.internal.util.PrefUtil;
022: import org.eclipse.ui.statushandlers.StatusManager;
023:
024: /**
025: * A menu for window creation in the workbench.
026: * <p>
027: * An <code>OpenPerspectiveMenu</code> is used to populate a menu with
028: * actions that will open a new perspective. If the user selects one of
029: * these items either a new page is added to the workbench, a new
030: * workbench window is created with the chosen perspective or the current
031: * perspective will be replaced with the new onw.
032: * </p><p>
033: * The visible perspectives within the menu may also be updated dynamically to
034: * reflect user preference.
035: * </p><p>
036: * The input for the page is determined by the value of <code>pageInput</code>.
037: * The input should be passed into the constructor of this class or set using
038: * the <code>setPageInput</code> method.
039: * </p><p>
040: * This class may be instantiated; it is not intended to be subclassed.
041: * </p>
042: * @deprecated See IWorkbench.showPerspective methods.
043: */
044: public class OpenPerspectiveMenu extends PerspectiveMenu {
045: private IAdaptable pageInput;
046:
047: private IMenuManager parentMenuManager;
048:
049: private boolean replaceEnabled = true;
050:
051: private static String PAGE_PROBLEMS_TITLE = WorkbenchMessages.OpenPerspectiveMenu_pageProblemsTitle;
052:
053: private static String PAGE_PROBLEMS_MESSAGE = WorkbenchMessages.OpenPerspectiveMenu_errorUnknownInput;
054:
055: /**
056: * Constructs a new menu.
057: */
058: public OpenPerspectiveMenu(IMenuManager menuManager,
059: IWorkbenchWindow window) {
060: this (window);
061: this .parentMenuManager = menuManager;
062: }
063:
064: /**
065: * Constructs a new instance of <code>OpenNewPageMenu</code>.
066: * <p>
067: * If this method is used be sure to set the page input by invoking
068: * <code>setPageInput</code>. The page input is required when the user
069: * selects an item in the menu. At that point the menu will attempt to
070: * open a new page with the selected perspective and page input. If there
071: * is no page input an error dialog will be opened.
072: * </p>
073: *
074: * @param window the window where a new page is created if an item within
075: * the menu is selected
076: */
077: public OpenPerspectiveMenu(IWorkbenchWindow window) {
078: this (window, null);
079: showActive(true);
080: }
081:
082: /**
083: * Constructs a new instance of <code>OpenNewPageMenu</code>.
084: *
085: * @param window the window where a new page is created if an item within
086: * the menu is selected
087: * @param input the page input
088: */
089: public OpenPerspectiveMenu(IWorkbenchWindow window, IAdaptable input) {
090: super (window, "Open New Page Menu");//$NON-NLS-1$
091: this .pageInput = input;
092: }
093:
094: /**
095: * Return whether or not the menu can be run. Answer true unless the current mode
096: * is replace and the replaceEnabled flag is false.
097: */
098: private boolean canRun() {
099: if (openPerspectiveSetting().equals(
100: IWorkbenchPreferenceConstants.OPEN_PERSPECTIVE_REPLACE)) {
101: return replaceEnabled;
102: }
103: return true;
104: }
105:
106: /**
107: * Return the current perspective setting.
108: */
109: private String openPerspectiveSetting() {
110: return PrefUtil.getAPIPreferenceStore().getString(
111: IWorkbenchPreferenceConstants.OPEN_NEW_PERSPECTIVE);
112: }
113:
114: /**
115: * Runs an action for a particular perspective. Opens the perspective supplied
116: * in a new window or a new page depending on the workbench preference.
117: *
118: * @param desc the selected perspective
119: */
120: protected void run(IPerspectiveDescriptor desc) {
121: openPage(desc, 0);
122: }
123:
124: /**
125: * Runs an action for a particular perspective. Check for shift or control events
126: * to decide which event to run.
127: *
128: * @param desc the selected perspective
129: * @param event the event sent along with the selection callback
130: */
131: protected void run(IPerspectiveDescriptor desc, SelectionEvent event) {
132: openPage(desc, event.stateMask);
133: }
134:
135: /* (non-Javadoc)
136: * Opens a new page with a particular perspective and input.
137: */
138: private void openPage(IPerspectiveDescriptor desc, int keyStateMask) {
139: // Verify page input.
140: if (pageInput == null) {
141: StatusUtil.handleStatus(PAGE_PROBLEMS_TITLE
142: + ": " + PAGE_PROBLEMS_MESSAGE, StatusManager.SHOW); //$NON-NLS-1$
143: return;
144: }
145:
146: // Open the page.
147: try {
148: getWindow().getWorkbench().showPerspective(desc.getId(),
149: getWindow(), pageInput);
150: } catch (WorkbenchException e) {
151: StatusUtil.handleStatus(PAGE_PROBLEMS_TITLE
152: + ": " + e.getMessage(), e, //$NON-NLS-1$
153: StatusManager.SHOW);
154: }
155: }
156:
157: /**
158: * Sets the page input.
159: *
160: * @param input the page input
161: */
162: public void setPageInput(IAdaptable input) {
163: pageInput = input;
164: }
165:
166: /**
167: * Set whether replace menu item is enabled within its parent menu.
168: */
169: public void setReplaceEnabled(boolean isEnabled) {
170: if (replaceEnabled != isEnabled) {
171: replaceEnabled = isEnabled;
172: if (canRun() && parentMenuManager != null) {
173: parentMenuManager.update(true);
174: }
175: }
176: }
177: }
|