KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jdt > ui > actions > OpenNewAnnotationWizardAction


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 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
12 package org.eclipse.jdt.ui.actions;
13
14 import org.eclipse.core.runtime.CoreException;
15
16 import org.eclipse.jface.viewers.IStructuredSelection;
17
18 import org.eclipse.ui.INewWizard;
19 import org.eclipse.ui.PlatformUI;
20
21 import org.eclipse.jdt.ui.wizards.NewAnnotationWizardPage;
22
23 import org.eclipse.jdt.internal.ui.IJavaHelpContextIds;
24 import org.eclipse.jdt.internal.ui.JavaPlugin;
25 import org.eclipse.jdt.internal.ui.JavaPluginImages;
26 import org.eclipse.jdt.internal.ui.actions.ActionMessages;
27 import org.eclipse.jdt.internal.ui.wizards.NewAnnotationCreationWizard;
28
29 /**
30 * <p>Action that opens the new annotation wizard.The action initialized the wizard with either the selection
31  * as configured by {@link #setSelection(IStructuredSelection)} or takes a preconfigured
32  * new annotation wizard page, see {@link #setConfiguredWizardPage(NewAnnotationWizardPage)}.
33  * </p>
34  *
35  * <p>
36  * This class may be instantiated; it is not intended to be subclassed.
37  * </p>
38  *
39  * @since 3.2
40  */
41 public class OpenNewAnnotationWizardAction extends AbstractOpenWizardAction {
42     
43     private NewAnnotationWizardPage fPage;
44     private boolean fOpenEditorOnFinish;
45
46     /**
47      * Creates an instance of the <code>OpenNewAnnotationWizardAction</code>.
48      */
49     public OpenNewAnnotationWizardAction() {
50         setText(ActionMessages.OpenNewAnnotationWizardAction_text);
51         setDescription(ActionMessages.OpenNewAnnotationWizardAction_description);
52         setToolTipText(ActionMessages.OpenNewAnnotationWizardAction_tooltip);
53         setImageDescriptor(JavaPluginImages.DESC_WIZBAN_NEWANNOT);
54         PlatformUI.getWorkbench().getHelpSystem().setHelp(this, IJavaHelpContextIds.OPEN_ANNOTATION_WIZARD_ACTION);
55         setShell(JavaPlugin.getActiveWorkbenchShell());
56         
57         fPage= null;
58         fOpenEditorOnFinish= true;
59     }
60     
61     /**
62      * Sets a page to be used by the wizard or <code>null</code> to use a page initialized with values
63      * from the current selection (see {@link #getSelection()} and {@link #setSelection(IStructuredSelection)}).
64      * @param page the page to use or <code>null</code>
65      */
66     public void setConfiguredWizardPage(NewAnnotationWizardPage page) {
67         fPage= page;
68     }
69     
70     /**
71      * Specifies if the wizard will open the created type with the default editor. The default behaviour is to open
72      * an editor.
73      *
74      * @param openEditorOnFinish if set, the wizard will open the created type with the default editor
75      *
76      * @since 3.3
77      */
78     public void setOpenEditorOnFinish(boolean openEditorOnFinish) {
79         fOpenEditorOnFinish= openEditorOnFinish;
80     }
81     
82     /* (non-Javadoc)
83      * @see org.eclipse.jdt.ui.actions.AbstractOpenWizardAction#createWizard()
84      */
85     protected final INewWizard createWizard() throws CoreException {
86         return new NewAnnotationCreationWizard(fPage, fOpenEditorOnFinish);
87     }
88 }
89
Popular Tags