Attachment #87688 for bug #216019

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

View | Details | Raw Unified | Return to bug 216019
Collapse All | Expand All

Lines 70-75 Link Here

(-)plugin.properties (+2 lines)
70	new.site.description=Create an Update Site project	70	new.site.description=Create an Update Site project
71	new.toc.name=Help Table of Contents	71	new.toc.name=Help Table of Contents
72	new.toc.description=Create a Table of Contents	72	new.toc.description=Create a Table of Contents
		73	new.ctxhelp.name=Context Help
		74	new.ctxhelp.description=Create a new Context Help xml file
73		75
74	PluginImportWizard.label=Plug-ins and Fragments	76	PluginImportWizard.label=Plug-ins and Fragments
75	PluginImportWizard.description=Create projects from plug-ins and fragments in the file system.	77	PluginImportWizard.description=Create projects from plug-ins and fragments in the file system.




            %new.toc.description
         </description>
      </wizard>
      <wizard
            category="org.eclipse.pde.userAssistance"
            class="org.eclipse.pde.internal.ui.wizards.ctxhelp.NewCtxHelpWizard"
            icon="icons/obj16/toc_obj.gif"
            id="org.eclipse.pde.ui.NewContextHelpWizard"
            name="%new.ctxhelp.name">
         <description>
            %new.ctxhelp.description
         </description>
      </wizard>
   </extension>
   <extension
         point="org.eclipse.ui.importWizards">

Lines 1007-1012 Link Here

(-)src/org/eclipse/pde/internal/ui/pderesources.properties (+5 lines)
1007	NewProductFileWizard_title=Product Configuration	1007	NewProductFileWizard_title=Product Configuration
1008	NewRestrictionDialog_title=New Restriction	1008	NewRestrictionDialog_title=New Restriction
1009	NewCategoryNameDialog_name=&Name:	1009	NewCategoryNameDialog_name=&Name:
		1010	NewCtxHelpOperation_ExampleContextId=Context
		1011	NewCtxHelpOperation_ExampleTopicLabel=Topic
		1012	NewCtxHelpWizard_NewContextHelp=New Context Help
		1013	NewCtxHelpWizardPage_contextHelpDescription=Create a new context help xml file.
		1014	NewCtxHelpWizardPage_contextHelpTitle=Context Help
1010		1015
1011	PointSelectionPage_tab1=Extension Points	1016	PointSelectionPage_tab1=Extension Points
1012	PointSelectionPage_tab2=Extension Wizards	1017	PointSelectionPage_tab2=Extension Wizards

Lines 24-30 Link Here

(-)src/org/eclipse/pde/internal/ui/IPDEUIConstants.java (-1 / +1 lines)
24	String SIMPLE_CHEAT_SHEET_EDITOR_ID = PLUGIN_ID + ".simpleCheatSheetEditor"; //$NON-NLS-1$	24	String SIMPLE_CHEAT_SHEET_EDITOR_ID = PLUGIN_ID + ".simpleCheatSheetEditor"; //$NON-NLS-1$
25	String COMPOSITE_CHEAT_SHEET_EDITOR_ID = PLUGIN_ID + ".compositeCheatSheetEditor"; //$NON-NLS-1$	25	String COMPOSITE_CHEAT_SHEET_EDITOR_ID = PLUGIN_ID + ".compositeCheatSheetEditor"; //$NON-NLS-1$
26	String TABLE_OF_CONTENTS_EDITOR_ID = PLUGIN_ID + ".tocEditor"; //$NON-NLS-1$	26	String TABLE_OF_CONTENTS_EDITOR_ID = PLUGIN_ID + ".tocEditor"; //$NON-NLS-1$
27	String CONTEXT_HELP_EDITOR_ID = PLUGIN_ID + ".helpContextEditor"; //$NON-NLS-1$	27	String CONTEXT_HELP_EDITOR_ID = PLUGIN_ID + ".ctxHelpEditor"; //$NON-NLS-1$
28	String TARGET_EDITOR_ID = PLUGIN_ID + ".targetEditor"; //$NON-NLS-1$	28	String TARGET_EDITOR_ID = PLUGIN_ID + ".targetEditor"; //$NON-NLS-1$
29	String PLUGINS_VIEW_ID = "org.eclipse.pde.ui.PluginsView"; //$NON-NLS-1$	29	String PLUGINS_VIEW_ID = "org.eclipse.pde.ui.PluginsView"; //$NON-NLS-1$
30	String DEPENDENCIES_VIEW_ID = "org.eclipse.pde.ui.DependenciesView"; //$NON-NLS-1$	30	String DEPENDENCIES_VIEW_ID = "org.eclipse.pde.ui.DependenciesView"; //$NON-NLS-1$





	public static String NewCheatSheetFileWizard_0;

	public static String NewCtxHelpOperation_ExampleContextId;

	public static String NewCtxHelpOperation_ExampleTopicLabel;

	public static String NewCtxHelpWizard_NewContextHelp;

	public static String NewCtxHelpWizardPage_contextHelpDescription;

	public static String NewCtxHelpWizardPage_contextHelpTitle;

	public static String NewLibraryPluginCreationPage_pdependencies;

	public static String OpenSchemaAction_errorMsgSchemaNotFound;




/*******************************************************************************
 * Copyright (c) 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.pde.internal.ui.wizards.ctxhelp;

import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.pde.internal.ui.PDEUIMessages;
import org.eclipse.pde.internal.ui.wizards.PDEWizardNewFileCreationPage;
import org.eclipse.swt.widgets.Composite;

/**
 * Wizard page to create a new context help xml file.
 * @since 3.4
 * @see NewCtxHelpWizard
 */
public class NewCtxHelpWizardPage extends PDEWizardNewFileCreationPage {

	private static String EXTENSION = "xml"; //$NON-NLS-1$

	public NewCtxHelpWizardPage(String pageName, IStructuredSelection selection) {
		super(pageName, selection);
		setTitle(PDEUIMessages.NewCtxHelpWizardPage_contextHelpTitle);
		setDescription(PDEUIMessages.NewCtxHelpWizardPage_contextHelpDescription);
		// Force the file extension to be 'xml'
		setFileExtension(EXTENSION);
	}

	protected void createAdvancedControls(Composite parent) {
		// We don't want any advanced controls showing up
	}

	public void createControl(Composite parent) {
		super.createControl(parent);
		// TODO Add help context
//		PlatformUI.getWorkbench().getHelpSystem().setHelp(getControl(), IHelpContextIds.TOC_PAGE);
	}

}




/*******************************************************************************
 * Copyright (c) 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.pde.internal.ui.wizards.ctxhelp;

import java.lang.reflect.InvocationTargetException;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.pde.internal.core.text.ctxhelp.*;
import org.eclipse.pde.internal.core.util.CoreUtility;
import org.eclipse.pde.internal.ui.*;
import org.eclipse.swt.widgets.Display;
import org.eclipse.ui.*;
import org.eclipse.ui.actions.WorkspaceModifyOperation;
import org.eclipse.ui.ide.IDE;
import org.eclipse.ui.part.ISetSelectionTarget;

/**
 * Operation to create a new context help xml file, add example entries and open it
 * in the context help editor.
 * @since 3.4
 */
public class NewCtxHelpOperation extends WorkspaceModifyOperation {

	private IFile fFile;

	public NewCtxHelpOperation(IFile file) {
		fFile = file;
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.actions.WorkspaceModifyOperation#execute(org.eclipse.core.runtime.IProgressMonitor)
	 */
	protected void execute(IProgressMonitor monitor) throws CoreException, InvocationTargetException, InterruptedException {
		CtxHelpModel model = new CtxHelpModel(CoreUtility.getTextDocument(fFile.getContents()), false);
		model.setUnderlyingResource(fFile);
		initializeModel(model);
		model.save();
		model.dispose();
		openFile();
		monitor.done();
	}

	/**
	 * Initialize the xml with example entries
	 * @param model model for the file
	 */
	private void initializeModel(CtxHelpModel model) {
		CtxHelpContext context = model.getFactory().createContext();
		context.setID(PDEUIMessages.NewCtxHelpOperation_ExampleContextId);
		model.getCtxHelpRoot().addChild(context);
		CtxHelpTopic topic = model.getFactory().createTopic();
		topic.setLabel(PDEUIMessages.NewCtxHelpOperation_ExampleTopicLabel);
		context.addChild(topic);
	}

	/**
	 * Asynchronously opens the created file in the context help editor.
	 */
	protected void openFile() {
		Display.getCurrent().asyncExec(new Runnable() {
			public void run() {
				IWorkbenchWindow ww = PDEPlugin.getActiveWorkbenchWindow();
				if (ww == null) {
					return;
				}
				IWorkbenchPage page = ww.getActivePage();
				if (page == null || !fFile.exists())
					return;
				IWorkbenchPart focusPart = page.getActivePart();
				if (focusPart instanceof ISetSelectionTarget) {
					ISelection selection = new StructuredSelection(fFile);
					((ISetSelectionTarget) focusPart).selectReveal(selection);
				}
				try {
					IDE.openEditor(page, fFile, IPDEUIConstants.CONTEXT_HELP_EDITOR_ID);
				} catch (PartInitException e) {
				}
			}
		});
	}

}




/*******************************************************************************
 * Copyright (c) 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.pde.internal.ui.wizards.ctxhelp;

import java.lang.reflect.InvocationTargetException;
import org.eclipse.core.resources.IFile;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.pde.internal.ui.*;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.wizards.newresource.BasicNewFileResourceWizard;

/**
 * Wizard to create a new context help file.
 * @since 3.4
 */
public class NewCtxHelpWizard extends BasicNewFileResourceWizard {

	protected NewCtxHelpWizardPage fMainPage;

	/* (non-Javadoc)
	 * @see org.eclipse.ui.wizards.newresource.BasicNewFileResourceWizard#addPages()
	 */
	public void addPages() {
		fMainPage = new NewCtxHelpWizardPage("new context help", getSelection()); //$NON-NLS-1$
		addPage(fMainPage);
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.wizards.newresource.BasicNewFileResourceWizard#init(org.eclipse.ui.IWorkbench, org.eclipse.jface.viewers.IStructuredSelection)
	 */
	public void init(IWorkbench workbench, IStructuredSelection currentSelection) {
		super.init(workbench, currentSelection);
		setWindowTitle(PDEUIMessages.NewCtxHelpWizard_NewContextHelp);
		setNeedsProgressMonitor(true);
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.wizards.newresource.BasicNewFileResourceWizard#initializeDefaultPageImageDescriptor()
	 */
	protected void initializeDefaultPageImageDescriptor() {
		setDefaultPageImageDescriptor(PDEPluginImages.DESC_TARGET_WIZ);
	}

	/* (non-Javadoc)
	 * @see org.eclipse.ui.wizards.newresource.BasicNewFileResourceWizard#performFinish()
	 */
	public boolean performFinish() {
		try {
			getContainer().run(false, true, getOperation());
		} catch (InvocationTargetException e) {
			PDEPlugin.logException(e);
			return false;
		} catch (InterruptedException e) {
			return false;
		}
		return true;
	}

	/**
	 * @return the operation to execute on finish
	 */
	private IRunnableWithProgress getOperation() {
		IFile file = fMainPage.createNewFile();
		return new NewCtxHelpOperation(file);
	}

}

Return to bug 216019

Lines 548-553 Link Here

(-)src/org/eclipse/pde/internal/ui/PDEUIMessages.java (+10 lines)
548		548
549	public static String NewCheatSheetFileWizard_0;	549	public static String NewCheatSheetFileWizard_0;
550		550
		551	public static String NewCtxHelpOperation_ExampleContextId;
		552
		553	public static String NewCtxHelpOperation_ExampleTopicLabel;
		554
		555	public static String NewCtxHelpWizard_NewContextHelp;
		556
		557	public static String NewCtxHelpWizardPage_contextHelpDescription;
		558
		559	public static String NewCtxHelpWizardPage_contextHelpTitle;
		560
551	public static String NewLibraryPluginCreationPage_pdependencies;	561	public static String NewLibraryPluginCreationPage_pdependencies;
552		562
553	public static String OpenSchemaAction_errorMsgSchemaNotFound;	563	public static String OpenSchemaAction_errorMsgSchemaNotFound;

Lines 216-221 Link Here

(-)plugin.xml (+10 lines)
216	%new.toc.description	216	%new.toc.description
217	</description>	217	</description>
218	</wizard>	218	</wizard>
		219	<wizard
		220	category="org.eclipse.pde.userAssistance"
		221	class="org.eclipse.pde.internal.ui.wizards.ctxhelp.NewCtxHelpWizard"
		222	icon="icons/obj16/toc_obj.gif"
		223	id="org.eclipse.pde.ui.NewContextHelpWizard"
		224	name="%new.ctxhelp.name">
		225	<description>
		226	%new.ctxhelp.description
		227	</description>
		228	</wizard>
219	</extension>	229	</extension>
220	<extension	230	<extension
221	point="org.eclipse.ui.importWizards">	231	point="org.eclipse.ui.importWizards">

Added Link Here

(-)src/org/eclipse/pde/internal/ui/wizards/ctxhelp/NewCtxHelpWizardPage.java (+46 lines)
1	/*******************************************************************************
2	* Copyright (c) 2008 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.pde.internal.ui.wizards.ctxhelp;
13
14	import org.eclipse.jface.viewers.IStructuredSelection;
15	import org.eclipse.pde.internal.ui.PDEUIMessages;
16	import org.eclipse.pde.internal.ui.wizards.PDEWizardNewFileCreationPage;
17	import org.eclipse.swt.widgets.Composite;
18
19	/**
20	* Wizard page to create a new context help xml file.
21	* @since 3.4
22	* @see NewCtxHelpWizard
23	*/
24	public class NewCtxHelpWizardPage extends PDEWizardNewFileCreationPage {
25
26	private static String EXTENSION = "xml"; //$NON-NLS-1$
27
28	public NewCtxHelpWizardPage(String pageName, IStructuredSelection selection) {
29	super(pageName, selection);
30	setTitle(PDEUIMessages.NewCtxHelpWizardPage_contextHelpTitle);
31	setDescription(PDEUIMessages.NewCtxHelpWizardPage_contextHelpDescription);
32	// Force the file extension to be 'xml'
33	setFileExtension(EXTENSION);
34	}
35
36	protected void createAdvancedControls(Composite parent) {
37	// We don't want any advanced controls showing up
38	}
39
40	public void createControl(Composite parent) {
41	super.createControl(parent);
42	// TODO Add help context
43	// PlatformUI.getWorkbench().getHelpSystem().setHelp(getControl(), IHelpContextIds.TOC_PAGE);
44	}
45
46	}