bundles/org.eclipse.ui.ide/src/org/eclipse/ui/internal/ide/ChooseWorkspaceDialog.java - platform/eclipse.platform.ui - Git at Google

 /*******************************************************************************
  * Copyright (c) 2004 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.ide;

 import org.eclipse.core.runtime.IProduct;
 import org.eclipse.core.runtime.Platform;
 import org.eclipse.jface.dialogs.IDialogConstants;
 import org.eclipse.jface.dialogs.TitleAreaDialog;
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.events.SelectionAdapter;
 import org.eclipse.swt.events.SelectionEvent;
 import org.eclipse.swt.layout.GridData;
 import org.eclipse.swt.layout.GridLayout;
 import org.eclipse.swt.widgets.Button;
 import org.eclipse.swt.widgets.Combo;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Control;
 import org.eclipse.swt.widgets.DirectoryDialog;
 import org.eclipse.swt.widgets.Label;
 import org.eclipse.swt.widgets.Shell;

 /**
  * A dialog that prompts for a directory to use as a workspace.
  */
 public class ChooseWorkspaceDialog extends TitleAreaDialog {
 	private ChooseWorkspaceData launchData;
 	private Combo text;
 	private boolean suppressAskAgain = false;

 	/**
      * Create a modal dialog on the arugment shell, using and updating the
      * argument data object.
      *
      * @param suppressAskAgain
      *            true means the dialog will not have a "don't ask again" button
      */
 	public ChooseWorkspaceDialog(Shell parentShell, ChooseWorkspaceData launchData, boolean suppressAskAgain) {
 		super(parentShell);
 		this.launchData = launchData;
 		this.suppressAskAgain = suppressAskAgain;
 	}

 	/**
 	 * Show the dialog to the user (if needed). When this method finishes,
 	 * #getSelection will return the workspace that should be used (whether it
 	 * was just selected by the user or some previous default has been used.
 	 * The parameter can be used to override the users preference.  For example,
 	 * this is important in cases where the default selection is already in use
 	 * and the user is forced to choose a different one.
 	 *
 	 * @param force
 	 *            true if the dialog should be opened regardless of the value of
 	 *            the show dialog checkbox
 	 */
 	public void prompt(boolean force) {
 		if (force || launchData.getShowDialog()) {
 			open();
 			return;
 		}

 		String[] recent = launchData.getRecentWorkspaces();
 		launchData.workspaceSelected(recent != null && recent.length > 0
 				? recent[0]
 				: launchData.getInitialDefault());
 	}

 	/**
 	 * Creates and returns the contents of the upper part of this dialog (above
 	 * the button bar).
 	 * <p>
 	 * The <code>Dialog</code> implementation of this framework method creates
 	 * and returns a new <code>Composite</code> with no margins and spacing.
 	 * </p>
 	 *
 	 * @param parent the parent composite to contain the dialog area
 	 * @return the dialog area control
 	 */
 	protected Control createDialogArea(Composite parent) {
 		String productName = null;
 		IProduct product = Platform.getProduct();
 		if (product != null) {
 			productName = product.getName();
 		}
 		if (productName == null) {
 		    productName = IDEWorkbenchMessages.getString("ChooseWorkspaceDialog.defaultProductName"); //$NON-NLS-1$
 		}

 		Composite composite = (Composite) super.createDialogArea(parent);
         setTitle(IDEWorkbenchMessages
                 .getString("ChooseWorkspaceDialog.dialogTitle")); //$NON-NLS-1$
         setMessage(IDEWorkbenchMessages.format(
                 "ChooseWorkspaceDialog.dialogMessage", //$NON-NLS-1$
                 new Object[] { productName }));

 		// bug 59934: load title image for sizing, but set it non-visible so the
 		//            white background is displayed
 		if (getTitleImageLabel() != null)
 		    getTitleImageLabel().setVisible(false);

 		createWorkspaceBrowseRow(composite);
 		if (!suppressAskAgain)
 			createShowDialogButton(composite);
 		return composite;
 	}

 	/**
 	 * Configures the given shell in preparation for opening this window
 	 * in it.
 	 * <p>
 	 * The default implementation of this framework method
 	 * sets the shell's image and gives it a grid layout.
 	 * Subclasses may extend or reimplement.
 	 * </p>
 	 *
 	 * @param shell the shell
 	 */
 	protected void configureShell(Shell shell) {
 		super.configureShell(shell);
 		shell.setText(IDEWorkbenchMessages
 				.getString("ChooseWorkspaceDialog.dialogName")); //$NON-NLS-1$
 	}

 	/**
 	 * Notifies that the ok button of this dialog has been pressed.
 	 * <p>
 	 * The <code>Dialog</code> implementation of this framework method sets
 	 * this dialog's return code to <code>Window.OK</code>
 	 * and closes the dialog. Subclasses may override.
 	 * </p>
 	 */
 	protected void okPressed() {
 		launchData.workspaceSelected(text.getText());
 		super.okPressed();
 	}

 	/**
 	 * Notifies that the cancel button of this dialog has been pressed.
 	 * <p>
 	 * The <code>Dialog</code> implementation of this framework method sets
 	 * this dialog's return code to <code>Window.CANCEL</code>
 	 * and closes the dialog. Subclasses may override if desired.
 	 * </p>
 	 */
 	protected void cancelPressed() {
 		launchData.workspaceSelected(null);
 		super.cancelPressed();
 	}

 	/**
 	 * The main area of the dialog is just a row with the current selection
 	 * information and a drop-down of the most recently used workspaces.
 	 */
 	private void createWorkspaceBrowseRow(Composite parent) {
 		Composite panel = new Composite(parent, SWT.NONE);

 		GridLayout layout = new GridLayout(3, false);
 		layout.marginHeight = convertVerticalDLUsToPixels(IDialogConstants.VERTICAL_MARGIN);
 		layout.marginWidth = convertHorizontalDLUsToPixels(IDialogConstants.HORIZONTAL_MARGIN);
 		layout.verticalSpacing = convertVerticalDLUsToPixels(IDialogConstants.VERTICAL_SPACING);
 		layout.horizontalSpacing = convertHorizontalDLUsToPixels(IDialogConstants.HORIZONTAL_SPACING);
 		panel.setLayout(layout);
 		panel.setLayoutData(new GridData(GridData.FILL_BOTH));
 		panel.setFont(parent.getFont());

 		Label label = new Label(panel, SWT.NONE);
 		label.setText(IDEWorkbenchMessages
 				.getString("ChooseWorkspaceDialog.workspaceEntryLabel")); //$NON-NLS-1$

 		text = new Combo(panel, SWT.BORDER | SWT.LEAD
 				| SWT.DROP_DOWN);
 		text.setLayoutData(new GridData(GridData.GRAB_HORIZONTAL
 				| GridData.FILL_HORIZONTAL));
 		setInitialTextValues(text);

 		Button browseButton = new Button(panel, SWT.PUSH);
 		browseButton.setText(IDEWorkbenchMessages
 				.getString("ChooseWorkspaceDialog.browseLabel")); //$NON-NLS-1$
 		setButtonLayoutData(browseButton);
 		GridData data = (GridData) browseButton.getLayoutData();
 		data.horizontalAlignment = GridData.HORIZONTAL_ALIGN_END;
 		browseButton.setLayoutData(data);
 		browseButton.addSelectionListener(new SelectionAdapter() {
 			public void widgetSelected(SelectionEvent e) {
 				DirectoryDialog dialog = new DirectoryDialog(getShell());
 				dialog.setText(IDEWorkbenchMessages
 								.getString("ChooseWorkspaceDialog.directoryBrowserTitle")); //$NON-NLS-1$
 				dialog.setMessage(IDEWorkbenchMessages
 								.getString("ChooseWorkspaceDialog.directoryBrowserMessage")); //$NON-NLS-1$
 				dialog.setFilterPath(text.getText());
 				String dir = dialog.open();
 				if (dir != null)
 					text.setText(dir);
 			}
 		});
 	}

 	/**
 	 * The show dialog button allows the user to choose to neven be nagged again.
 	 */
 	private void createShowDialogButton(Composite parent) {
 		Composite panel = new Composite(parent, SWT.NONE);
 		panel.setFont(parent.getFont());

 		GridLayout layout = new GridLayout(1, false);
 		layout.marginWidth = convertHorizontalDLUsToPixels(IDialogConstants.HORIZONTAL_MARGIN);
 		panel.setLayout(layout);

 		GridData data = new GridData(GridData.FILL_BOTH);
 		data.verticalAlignment = GridData.END;
 		panel.setLayoutData(data);

 		Button button = new Button(panel, SWT.CHECK);
 		button.setText(IDEWorkbenchMessages
 				.getString("ChooseWorkspaceDialog.useDefaultMessage")); //$NON-NLS-1$
 		button.setSelection(!launchData.getShowDialog());
 		button.addSelectionListener(new SelectionAdapter() {
 			public void widgetSelected(SelectionEvent e) {
 				launchData.toggleShowDialog();
 			}
 		});
 	}

 	private void setInitialTextValues(Combo text) {
 		String[] recentWorkspaces = launchData.getRecentWorkspaces();
 		for(int i = 0; i < recentWorkspaces.length; ++i)
 			if(recentWorkspaces[i] != null)
 				text.add(recentWorkspaces[i]);

 		text.setText(text.getItemCount() > 0 ? text.getItem(0) : launchData
 				.getInitialDefault());
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2004 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.ide;

	import org.eclipse.core.runtime.IProduct;
	import org.eclipse.core.runtime.Platform;
	import org.eclipse.jface.dialogs.IDialogConstants;
	import org.eclipse.jface.dialogs.TitleAreaDialog;
	import org.eclipse.swt.SWT;
	import org.eclipse.swt.events.SelectionAdapter;
	import org.eclipse.swt.events.SelectionEvent;
	import org.eclipse.swt.layout.GridData;
	import org.eclipse.swt.layout.GridLayout;
	import org.eclipse.swt.widgets.Button;
	import org.eclipse.swt.widgets.Combo;
	import org.eclipse.swt.widgets.Composite;
	import org.eclipse.swt.widgets.Control;
	import org.eclipse.swt.widgets.DirectoryDialog;
	import org.eclipse.swt.widgets.Label;
	import org.eclipse.swt.widgets.Shell;

	/**
	* A dialog that prompts for a directory to use as a workspace.
	*/
	public class ChooseWorkspaceDialog extends TitleAreaDialog {
	private ChooseWorkspaceData launchData;
	private Combo text;
	private boolean suppressAskAgain = false;

	/**
	* Create a modal dialog on the arugment shell, using and updating the
	* argument data object.
	*
	* @param suppressAskAgain
	* true means the dialog will not have a "don't ask again" button
	*/
	public ChooseWorkspaceDialog(Shell parentShell, ChooseWorkspaceData launchData, boolean suppressAskAgain) {
	super(parentShell);
	this.launchData = launchData;
	this.suppressAskAgain = suppressAskAgain;
	}

	/**
	* Show the dialog to the user (if needed). When this method finishes,
	* #getSelection will return the workspace that should be used (whether it
	* was just selected by the user or some previous default has been used.
	* The parameter can be used to override the users preference. For example,
	* this is important in cases where the default selection is already in use
	* and the user is forced to choose a different one.
	*
	* @param force
	* true if the dialog should be opened regardless of the value of
	* the show dialog checkbox
	*/
	public void prompt(boolean force) {
	if (force \|\| launchData.getShowDialog()) {
	open();
	return;
	}

	String[] recent = launchData.getRecentWorkspaces();
	launchData.workspaceSelected(recent != null && recent.length > 0
	? recent[0]
	: launchData.getInitialDefault());
	}

	/**
	* Creates and returns the contents of the upper part of this dialog (above
	* the button bar).
	* <p>
	* The <code>Dialog</code> implementation of this framework method creates
	* and returns a new <code>Composite</code> with no margins and spacing.
	* </p>
	*
	* @param parent the parent composite to contain the dialog area
	* @return the dialog area control
	*/
	protected Control createDialogArea(Composite parent) {
	String productName = null;
	IProduct product = Platform.getProduct();
	if (product != null) {
	productName = product.getName();
	}
	if (productName == null) {
	productName = IDEWorkbenchMessages.getString("ChooseWorkspaceDialog.defaultProductName"); //$NON-NLS-1$
	}

	Composite composite = (Composite) super.createDialogArea(parent);
	setTitle(IDEWorkbenchMessages
	.getString("ChooseWorkspaceDialog.dialogTitle")); //$NON-NLS-1$
	setMessage(IDEWorkbenchMessages.format(
	"ChooseWorkspaceDialog.dialogMessage", //$NON-NLS-1$
	new Object[] { productName }));

	// bug 59934: load title image for sizing, but set it non-visible so the
	// white background is displayed
	if (getTitleImageLabel() != null)
	getTitleImageLabel().setVisible(false);

	createWorkspaceBrowseRow(composite);
	if (!suppressAskAgain)
	createShowDialogButton(composite);
	return composite;
	}

	/**
	* Configures the given shell in preparation for opening this window
	* in it.
	* <p>
	* The default implementation of this framework method
	* sets the shell's image and gives it a grid layout.
	* Subclasses may extend or reimplement.
	* </p>
	*
	* @param shell the shell
	*/
	protected void configureShell(Shell shell) {
	super.configureShell(shell);
	shell.setText(IDEWorkbenchMessages
	.getString("ChooseWorkspaceDialog.dialogName")); //$NON-NLS-1$
	}

	/**
	* Notifies that the ok button of this dialog has been pressed.
	* <p>
	* The <code>Dialog</code> implementation of this framework method sets
	* this dialog's return code to <code>Window.OK</code>
	* and closes the dialog. Subclasses may override.
	* </p>
	*/
	protected void okPressed() {
	launchData.workspaceSelected(text.getText());
	super.okPressed();
	}

	/**
	* Notifies that the cancel button of this dialog has been pressed.
	* <p>
	* The <code>Dialog</code> implementation of this framework method sets
	* this dialog's return code to <code>Window.CANCEL</code>
	* and closes the dialog. Subclasses may override if desired.
	* </p>
	*/
	protected void cancelPressed() {
	launchData.workspaceSelected(null);
	super.cancelPressed();
	}

	/**
	* The main area of the dialog is just a row with the current selection
	* information and a drop-down of the most recently used workspaces.
	*/
	private void createWorkspaceBrowseRow(Composite parent) {
	Composite panel = new Composite(parent, SWT.NONE);

	GridLayout layout = new GridLayout(3, false);
	layout.marginHeight = convertVerticalDLUsToPixels(IDialogConstants.VERTICAL_MARGIN);
	layout.marginWidth = convertHorizontalDLUsToPixels(IDialogConstants.HORIZONTAL_MARGIN);
	layout.verticalSpacing = convertVerticalDLUsToPixels(IDialogConstants.VERTICAL_SPACING);
	layout.horizontalSpacing = convertHorizontalDLUsToPixels(IDialogConstants.HORIZONTAL_SPACING);
	panel.setLayout(layout);
	panel.setLayoutData(new GridData(GridData.FILL_BOTH));
	panel.setFont(parent.getFont());

	Label label = new Label(panel, SWT.NONE);
	label.setText(IDEWorkbenchMessages
	.getString("ChooseWorkspaceDialog.workspaceEntryLabel")); //$NON-NLS-1$

	text = new Combo(panel, SWT.BORDER \| SWT.LEAD
	\| SWT.DROP_DOWN);
	text.setLayoutData(new GridData(GridData.GRAB_HORIZONTAL
	\| GridData.FILL_HORIZONTAL));
	setInitialTextValues(text);

	Button browseButton = new Button(panel, SWT.PUSH);
	browseButton.setText(IDEWorkbenchMessages
	.getString("ChooseWorkspaceDialog.browseLabel")); //$NON-NLS-1$
	setButtonLayoutData(browseButton);
	GridData data = (GridData) browseButton.getLayoutData();
	data.horizontalAlignment = GridData.HORIZONTAL_ALIGN_END;
	browseButton.setLayoutData(data);
	browseButton.addSelectionListener(new SelectionAdapter() {
	public void widgetSelected(SelectionEvent e) {
	DirectoryDialog dialog = new DirectoryDialog(getShell());
	dialog.setText(IDEWorkbenchMessages
	.getString("ChooseWorkspaceDialog.directoryBrowserTitle")); //$NON-NLS-1$
	dialog.setMessage(IDEWorkbenchMessages
	.getString("ChooseWorkspaceDialog.directoryBrowserMessage")); //$NON-NLS-1$
	dialog.setFilterPath(text.getText());
	String dir = dialog.open();
	if (dir != null)
	text.setText(dir);
	}
	});
	}

	/**
	* The show dialog button allows the user to choose to neven be nagged again.
	*/
	private void createShowDialogButton(Composite parent) {
	Composite panel = new Composite(parent, SWT.NONE);
	panel.setFont(parent.getFont());

	GridLayout layout = new GridLayout(1, false);
	layout.marginWidth = convertHorizontalDLUsToPixels(IDialogConstants.HORIZONTAL_MARGIN);
	panel.setLayout(layout);

	GridData data = new GridData(GridData.FILL_BOTH);
	data.verticalAlignment = GridData.END;
	panel.setLayoutData(data);

	Button button = new Button(panel, SWT.CHECK);
	button.setText(IDEWorkbenchMessages
	.getString("ChooseWorkspaceDialog.useDefaultMessage")); //$NON-NLS-1$
	button.setSelection(!launchData.getShowDialog());
	button.addSelectionListener(new SelectionAdapter() {
	public void widgetSelected(SelectionEvent e) {
	launchData.toggleShowDialog();
	}
	});
	}

	private void setInitialTextValues(Combo text) {
	String[] recentWorkspaces = launchData.getRecentWorkspaces();
	for(int i = 0; i < recentWorkspaces.length; ++i)
	if(recentWorkspaces[i] != null)
	text.add(recentWorkspaces[i]);

	text.setText(text.getItemCount() > 0 ? text.getItem(0) : launchData
	.getInitialDefault());
	}
	}