ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/wizards/product/ProductDefinitonWizardPage.java - pde/eclipse.pde.ui - Git at Google

 /*******************************************************************************
  * Copyright (c) 2005, 2015 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
  * which accompanies this distribution, and is available at
  * https://www.eclipse.org/legal/epl-2.0/
  *
  * SPDX-License-Identifier: EPL-2.0
  *
  * Contributors:
  *     IBM Corporation - initial API and implementation
  *******************************************************************************/
 package org.eclipse.pde.internal.ui.wizards.product;

 import static org.eclipse.swt.events.SelectionListener.widgetSelectedAdapter;

 import java.util.Set;
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.runtime.Platform;
 import org.eclipse.jface.dialogs.Dialog;
 import org.eclipse.jface.window.Window;
 import org.eclipse.jface.wizard.WizardPage;
 import org.eclipse.pde.core.plugin.*;
 import org.eclipse.pde.internal.core.PDECore;
 import org.eclipse.pde.internal.core.TargetPlatformHelper;
 import org.eclipse.pde.internal.core.iproduct.IProduct;
 import org.eclipse.pde.internal.ui.IHelpContextIds;
 import org.eclipse.pde.internal.ui.PDEUIMessages;
 import org.eclipse.pde.internal.ui.dialogs.PluginSelectionDialog;
 import org.eclipse.pde.internal.ui.search.ShowDescriptionAction;
 import org.eclipse.pde.internal.ui.util.SWTUtil;
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.events.ModifyListener;
 import org.eclipse.swt.layout.GridData;
 import org.eclipse.swt.layout.GridLayout;
 import org.eclipse.swt.widgets.*;
 import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.forms.events.HyperlinkEvent;
 import org.eclipse.ui.forms.events.IHyperlinkListener;
 import org.eclipse.ui.forms.widgets.FormText;
 import org.eclipse.ui.forms.widgets.FormToolkit;

 public class ProductDefinitonWizardPage extends WizardPage implements IHyperlinkListener {

 	private Text fProductName;
 	private Text fPluginText;
 	private Text fProductText;
 	private Set<String> fProductSet;
 	private Combo fApplicationCombo;
 	private IProduct fProduct;

 	private ModifyListener fListener = e -> validatePage();

 	public ProductDefinitonWizardPage(String pageName, IProduct product) {
 		super(pageName);
 		fProduct = product;
 		setTitle(PDEUIMessages.ProductDefinitonWizardPage_title);
 		if (productNameDefined())
 			setDescription(PDEUIMessages.ProductDefinitonWizardPage_desc);
 		else
 			setDescription(PDEUIMessages.ProductDefinitonWizardPage_descNoName);
 	}

 	@Override
 	public void createControl(Composite parent) {
 		Composite comp = new Composite(parent, SWT.NONE);
 		GridLayout layout = new GridLayout();
 		layout.verticalSpacing = 20;
 		comp.setLayout(layout);

 		FormToolkit toolkit = new FormToolkit(parent.getDisplay());
 		createProductGroup(toolkit, comp);
 		createApplicationGroup(toolkit, comp);
 		toolkit.dispose();
 		setControl(comp);
 		setPageComplete(getPluginId() != null && productNameDefined());
 		Dialog.applyDialogFont(comp);
 		PlatformUI.getWorkbench().getHelpSystem().setHelp(comp, IHelpContextIds.PRODUCT_DEFINITIONS_WIZARD);
 	}

 	private void createFormText(FormToolkit toolkit, Composite parent, String content, int span) {
 		FormText text = toolkit.createFormText(parent, false);
 		text.setText(content, true, false);
 		GridData gd = new GridData(GridData.FILL_HORIZONTAL);
 		gd.horizontalSpan = span;
 		gd.widthHint = 400;
 		text.setLayoutData(gd);
 		text.setBackground(parent.getBackground());
 		text.addHyperlinkListener(this);
 	}

 	private void createProductGroup(FormToolkit toolkit, Composite comp) {
 		Group group = new Group(comp, SWT.NONE);
 		group.setText(PDEUIMessages.ProductDefinitonWizardPage_productGroup);
 		group.setLayout(new GridLayout(3, false));
 		group.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

 		createFormText(toolkit, group, PDEUIMessages.ProductDefinitonWizardPage_productDefinition, 3);

 		Label label;
 		GridData gd = new GridData(GridData.FILL_HORIZONTAL);
 		gd.horizontalSpan = 2;

 		if (!productNameDefined()) {
 			label = new Label(group, SWT.NONE);
 			label.setText(PDEUIMessages.ProductDefinitonWizardPage_productName);

 			fProductName = new Text(group, SWT.SINGLE | SWT.BORDER);
 			fProductName.setLayoutData(gd);
 			fProductName.addModifyListener(fListener);
 		}

 		label = new Label(group, SWT.NONE);
 		label.setText(PDEUIMessages.ProductDefinitonWizardPage_plugin);

 		fPluginText = new Text(group, SWT.SINGLE | SWT.BORDER);
 		fPluginText.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

 		Button button = new Button(group, SWT.PUSH);
 		button.setText(PDEUIMessages.ProductDefinitonWizardPage_browse);
 		SWTUtil.setButtonDimensionHint(button);
 		button.addSelectionListener(widgetSelectedAdapter(e -> handleBrowse()));

 		label = new Label(group, SWT.NONE);
 		label.setText(PDEUIMessages.ProductDefinitonWizardPage_productId);

 		fProductText = new Text(group, SWT.SINGLE | SWT.BORDER);
 		fProductText.setLayoutData(gd);

 		String pluginId = getPluginId();
 		if (pluginId != null) {
 			fPluginText.setText(pluginId);
 			String productId = "product"; //$NON-NLS-1$
 			String numString = ""; //$NON-NLS-1$
 			int idNum = 1;
 			while (getProductNameSet().contains(pluginId + "." + productId + numString)) { //$NON-NLS-1$
 				numString = Integer.toString(idNum++);
 			}
 			fProductText.setText(productId + numString);
 		}
 		fPluginText.addModifyListener(fListener);
 		fProductText.addModifyListener(fListener);

 	}

 	private void createApplicationGroup(FormToolkit toolkit, Composite comp) {
 		Group group = new Group(comp, SWT.NONE);
 		group.setText(PDEUIMessages.ProductDefinitonWizardPage_applicationGroup);
 		group.setLayout(new GridLayout(2, false));
 		group.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

 		createFormText(toolkit, group, PDEUIMessages.ProductDefinitonWizardPage_applicationDefinition, 2);

 		Label label = new Label(group, SWT.NONE);
 		label.setText(PDEUIMessages.ProductDefinitonWizardPage_application);

 		fApplicationCombo = new Combo(group, SWT.SINGLE | SWT.READ_ONLY);
 		fApplicationCombo.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
 		fApplicationCombo.setItems(TargetPlatform.getApplications());
 		if (fApplicationCombo.getItemCount() > 0)
 			fApplicationCombo.setText(fApplicationCombo.getItem(0));
 	}

 	@Override
 	public void setVisible(boolean visible) {
 		if (visible) {
 			if (fProductName != null)
 				fProductName.setFocus();
 			else
 				fPluginText.setFocus();
 		}
 		super.setVisible(visible);
 	}

 	private void validatePage() {
 		String error = null;
 		String productName = getProductName();
 		if (productName != null && productName.length() == 0) {
 			error = PDEUIMessages.ProductDefinitonWizardPage_noProductName;
 		}
 		validateIdAndProduct(error);
 	}

 	private void validateIdAndProduct(String error) {
 		if (error == null) {
 			String pluginId = getDefiningPlugin();
 			IPluginModelBase model = PluginRegistry.findModel(pluginId);
 			if (pluginId.length() == 0) {
 				error = PDEUIMessages.ProductDefinitonWizardPage_noPluginId;
 			} else if (model == null) {
 				error = PDEUIMessages.ProductDefinitonWizardPage_noPlugin;
 			} else if (model.getUnderlyingResource() == null) {
 				error = PDEUIMessages.ProductDefinitonWizardPage_notInWorkspace;
 			}
 			if (error == null)
 				error = validateId();
 			if (error == null && getProductNameSet().contains(pluginId + "." + fProductText.getText().trim())) { //$NON-NLS-1$
 				error = PDEUIMessages.ProductDefinitonWizardPage_productExists;
 			}
 		}
 		setErrorMessage(error);
 		setPageComplete(error == null);
 	}

 	private String validateId() {
 		String id = fProductText.getText().trim();
 		if (id.length() == 0)
 			return PDEUIMessages.ProductDefinitonWizardPage_noProductID;

 		for (int i = 0; i < id.length(); i++) {
 			if (!id.substring(i, i + 1).matches("[a-zA-Z0-9_]")) //$NON-NLS-1$
 				return PDEUIMessages.ProductDefinitonWizardPage_invalidId;
 		}
 		return null;
 	}

 	@Override
 	public void linkEntered(HyperlinkEvent e) {
 	}

 	@Override
 	public void linkExited(HyperlinkEvent e) {
 	}

 	@Override
 	public void linkActivated(HyperlinkEvent e) {
 		String extPoint = Platform.PI_RUNTIME + "." + e.getHref().toString(); //$NON-NLS-1$
 		IPluginExtensionPoint point = PDECore.getDefault().getExtensionsRegistry().findExtensionPoint(extPoint);
 		if (point != null)
 			new ShowDescriptionAction(point, true).run();
 	}

 	private void handleBrowse() {
 		PluginSelectionDialog dialog = new PluginSelectionDialog(getShell(), PluginRegistry.getWorkspaceModels(), false);
 		if (dialog.open() == Window.OK) {
 			IPluginModelBase model = (IPluginModelBase) dialog.getFirstResult();
 			fPluginText.setText(model.getPluginBase().getId());
 		}
 	}

 	private Set<String> getProductNameSet() {
 		if (fProductSet == null)
 			fProductSet = TargetPlatformHelper.getProductNameSet();
 		return fProductSet;
 	}

 	public String getDefiningPlugin() {
 		return fPluginText.getText().trim();
 	}

 	public String getProductId() {
 		return fProductText.getText().trim();
 	}

 	public String getApplication() {
 		return fApplicationCombo.getText();
 	}

 	public String getProductName() {
 		return (fProductName == null) ? null : fProductName.getText().trim();
 	}

 	private boolean productNameDefined() {
 		return (fProduct.getName() != null && !fProduct.getName().equals("")); //$NON-NLS-1$
 	}

 	private String getPluginId() {
 		IProject project = fProduct.getModel().getUnderlyingResource().getProject();
 		IPluginModelBase model = PluginRegistry.findModel(project);
 		return (model == null) ? null : model.getPluginBase().getId();
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2005, 2015 IBM Corporation and others.
	*
	* This program and the accompanying materials
	* are made available under the terms of the Eclipse Public License 2.0
	* which accompanies this distribution, and is available at
	* https://www.eclipse.org/legal/epl-2.0/
	*
	* SPDX-License-Identifier: EPL-2.0
	*
	* Contributors:
	* IBM Corporation - initial API and implementation
	*******************************************************************************/
	package org.eclipse.pde.internal.ui.wizards.product;

	import static org.eclipse.swt.events.SelectionListener.widgetSelectedAdapter;

	import java.util.Set;
	import org.eclipse.core.resources.IProject;
	import org.eclipse.core.runtime.Platform;
	import org.eclipse.jface.dialogs.Dialog;
	import org.eclipse.jface.window.Window;
	import org.eclipse.jface.wizard.WizardPage;
	import org.eclipse.pde.core.plugin.*;
	import org.eclipse.pde.internal.core.PDECore;
	import org.eclipse.pde.internal.core.TargetPlatformHelper;
	import org.eclipse.pde.internal.core.iproduct.IProduct;
	import org.eclipse.pde.internal.ui.IHelpContextIds;
	import org.eclipse.pde.internal.ui.PDEUIMessages;
	import org.eclipse.pde.internal.ui.dialogs.PluginSelectionDialog;
	import org.eclipse.pde.internal.ui.search.ShowDescriptionAction;
	import org.eclipse.pde.internal.ui.util.SWTUtil;
	import org.eclipse.swt.SWT;
	import org.eclipse.swt.events.ModifyListener;
	import org.eclipse.swt.layout.GridData;
	import org.eclipse.swt.layout.GridLayout;
	import org.eclipse.swt.widgets.*;
	import org.eclipse.ui.PlatformUI;
	import org.eclipse.ui.forms.events.HyperlinkEvent;
	import org.eclipse.ui.forms.events.IHyperlinkListener;
	import org.eclipse.ui.forms.widgets.FormText;
	import org.eclipse.ui.forms.widgets.FormToolkit;

	public class ProductDefinitonWizardPage extends WizardPage implements IHyperlinkListener {

	private Text fProductName;
	private Text fPluginText;
	private Text fProductText;
	private Set<String> fProductSet;
	private Combo fApplicationCombo;
	private IProduct fProduct;

	private ModifyListener fListener = e -> validatePage();

	public ProductDefinitonWizardPage(String pageName, IProduct product) {
	super(pageName);
	fProduct = product;
	setTitle(PDEUIMessages.ProductDefinitonWizardPage_title);
	if (productNameDefined())
	setDescription(PDEUIMessages.ProductDefinitonWizardPage_desc);
	else
	setDescription(PDEUIMessages.ProductDefinitonWizardPage_descNoName);
	}

	@Override
	public void createControl(Composite parent) {
	Composite comp = new Composite(parent, SWT.NONE);
	GridLayout layout = new GridLayout();
	layout.verticalSpacing = 20;
	comp.setLayout(layout);

	FormToolkit toolkit = new FormToolkit(parent.getDisplay());
	createProductGroup(toolkit, comp);
	createApplicationGroup(toolkit, comp);
	toolkit.dispose();
	setControl(comp);
	setPageComplete(getPluginId() != null && productNameDefined());
	Dialog.applyDialogFont(comp);
	PlatformUI.getWorkbench().getHelpSystem().setHelp(comp, IHelpContextIds.PRODUCT_DEFINITIONS_WIZARD);
	}

	private void createFormText(FormToolkit toolkit, Composite parent, String content, int span) {
	FormText text = toolkit.createFormText(parent, false);
	text.setText(content, true, false);
	GridData gd = new GridData(GridData.FILL_HORIZONTAL);
	gd.horizontalSpan = span;
	gd.widthHint = 400;
	text.setLayoutData(gd);
	text.setBackground(parent.getBackground());
	text.addHyperlinkListener(this);
	}

	private void createProductGroup(FormToolkit toolkit, Composite comp) {
	Group group = new Group(comp, SWT.NONE);
	group.setText(PDEUIMessages.ProductDefinitonWizardPage_productGroup);
	group.setLayout(new GridLayout(3, false));
	group.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

	createFormText(toolkit, group, PDEUIMessages.ProductDefinitonWizardPage_productDefinition, 3);

	Label label;
	GridData gd = new GridData(GridData.FILL_HORIZONTAL);
	gd.horizontalSpan = 2;

	if (!productNameDefined()) {
	label = new Label(group, SWT.NONE);
	label.setText(PDEUIMessages.ProductDefinitonWizardPage_productName);

	fProductName = new Text(group, SWT.SINGLE \| SWT.BORDER);
	fProductName.setLayoutData(gd);
	fProductName.addModifyListener(fListener);
	}

	label = new Label(group, SWT.NONE);
	label.setText(PDEUIMessages.ProductDefinitonWizardPage_plugin);

	fPluginText = new Text(group, SWT.SINGLE \| SWT.BORDER);
	fPluginText.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

	Button button = new Button(group, SWT.PUSH);
	button.setText(PDEUIMessages.ProductDefinitonWizardPage_browse);
	SWTUtil.setButtonDimensionHint(button);
	button.addSelectionListener(widgetSelectedAdapter(e -> handleBrowse()));

	label = new Label(group, SWT.NONE);
	label.setText(PDEUIMessages.ProductDefinitonWizardPage_productId);

	fProductText = new Text(group, SWT.SINGLE \| SWT.BORDER);
	fProductText.setLayoutData(gd);

	String pluginId = getPluginId();
	if (pluginId != null) {
	fPluginText.setText(pluginId);
	String productId = "product"; //$NON-NLS-1$
	String numString = ""; //$NON-NLS-1$
	int idNum = 1;
	while (getProductNameSet().contains(pluginId + "." + productId + numString)) { //$NON-NLS-1$
	numString = Integer.toString(idNum++);
	}
	fProductText.setText(productId + numString);
	}
	fPluginText.addModifyListener(fListener);
	fProductText.addModifyListener(fListener);

	}

	private void createApplicationGroup(FormToolkit toolkit, Composite comp) {
	Group group = new Group(comp, SWT.NONE);
	group.setText(PDEUIMessages.ProductDefinitonWizardPage_applicationGroup);
	group.setLayout(new GridLayout(2, false));
	group.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

	createFormText(toolkit, group, PDEUIMessages.ProductDefinitonWizardPage_applicationDefinition, 2);

	Label label = new Label(group, SWT.NONE);
	label.setText(PDEUIMessages.ProductDefinitonWizardPage_application);

	fApplicationCombo = new Combo(group, SWT.SINGLE \| SWT.READ_ONLY);
	fApplicationCombo.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
	fApplicationCombo.setItems(TargetPlatform.getApplications());
	if (fApplicationCombo.getItemCount() > 0)
	fApplicationCombo.setText(fApplicationCombo.getItem(0));
	}

	@Override
	public void setVisible(boolean visible) {
	if (visible) {
	if (fProductName != null)
	fProductName.setFocus();
	else
	fPluginText.setFocus();
	}
	super.setVisible(visible);
	}

	private void validatePage() {
	String error = null;
	String productName = getProductName();
	if (productName != null && productName.length() == 0) {
	error = PDEUIMessages.ProductDefinitonWizardPage_noProductName;
	}
	validateIdAndProduct(error);
	}

	private void validateIdAndProduct(String error) {
	if (error == null) {
	String pluginId = getDefiningPlugin();
	IPluginModelBase model = PluginRegistry.findModel(pluginId);
	if (pluginId.length() == 0) {
	error = PDEUIMessages.ProductDefinitonWizardPage_noPluginId;
	} else if (model == null) {
	error = PDEUIMessages.ProductDefinitonWizardPage_noPlugin;
	} else if (model.getUnderlyingResource() == null) {
	error = PDEUIMessages.ProductDefinitonWizardPage_notInWorkspace;
	}
	if (error == null)
	error = validateId();
	if (error == null && getProductNameSet().contains(pluginId + "." + fProductText.getText().trim())) { //$NON-NLS-1$
	error = PDEUIMessages.ProductDefinitonWizardPage_productExists;
	}
	}
	setErrorMessage(error);
	setPageComplete(error == null);
	}

	private String validateId() {
	String id = fProductText.getText().trim();
	if (id.length() == 0)
	return PDEUIMessages.ProductDefinitonWizardPage_noProductID;

	for (int i = 0; i < id.length(); i++) {
	if (!id.substring(i, i + 1).matches("[a-zA-Z0-9_]")) //$NON-NLS-1$
	return PDEUIMessages.ProductDefinitonWizardPage_invalidId;
	}
	return null;
	}

	@Override
	public void linkEntered(HyperlinkEvent e) {
	}

	@Override
	public void linkExited(HyperlinkEvent e) {
	}

	@Override
	public void linkActivated(HyperlinkEvent e) {
	String extPoint = Platform.PI_RUNTIME + "." + e.getHref().toString(); //$NON-NLS-1$
	IPluginExtensionPoint point = PDECore.getDefault().getExtensionsRegistry().findExtensionPoint(extPoint);
	if (point != null)
	new ShowDescriptionAction(point, true).run();
	}

	private void handleBrowse() {
	PluginSelectionDialog dialog = new PluginSelectionDialog(getShell(), PluginRegistry.getWorkspaceModels(), false);
	if (dialog.open() == Window.OK) {
	IPluginModelBase model = (IPluginModelBase) dialog.getFirstResult();
	fPluginText.setText(model.getPluginBase().getId());
	}
	}

	private Set<String> getProductNameSet() {
	if (fProductSet == null)
	fProductSet = TargetPlatformHelper.getProductNameSet();
	return fProductSet;
	}

	public String getDefiningPlugin() {
	return fPluginText.getText().trim();
	}

	public String getProductId() {
	return fProductText.getText().trim();
	}

	public String getApplication() {
	return fApplicationCombo.getText();
	}

	public String getProductName() {
	return (fProductName == null) ? null : fProductName.getText().trim();
	}

	private boolean productNameDefined() {
	return (fProduct.getName() != null && !fProduct.getName().equals("")); //$NON-NLS-1$
	}

	private String getPluginId() {
	IProject project = fProduct.getModel().getUnderlyingResource().getProject();
	IPluginModelBase model = PluginRegistry.findModel(project);
	return (model == null) ? null : model.getPluginBase().getId();
	}
	}