RefactoringWizardDialog.java

/*******************************************************************************
 * Copyright (c) 2000, 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.ltk.internal.ui.refactoring;

import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Shell;

import org.eclipse.jface.dialogs.DialogSettings;
import org.eclipse.jface.dialogs.IDialogConstants;
import org.eclipse.jface.dialogs.IDialogSettings;
import org.eclipse.jface.wizard.IWizardPage;
import org.eclipse.jface.wizard.WizardDialog;

import org.eclipse.ltk.core.refactoring.codingspectator.NavigationHistoryItem;
import org.eclipse.ltk.ui.refactoring.RefactoringWizard;

/**
 * A dialog to host refactoring wizards.
 * 
 * @author Mohsen Vakilian, nchen - Recorded the navigation history of the refactoring wizard.
 * 
 */
public class RefactoringWizardDialog extends WizardDialog {

	private static final String DIALOG_SETTINGS= "RefactoringWizard"; //$NON-NLS-1$

	private static final String WIDTH= "width"; //$NON-NLS-1$

	private static final String HEIGHT= "height"; //$NON-NLS-1$

	private IDialogSettings fSettings;

	/*
	 * note: this field must not be initialized - setter is called in the call to super
	 * and java initializes fields 'after' the call to super is made. So initializing
	 * would override setting.
	 */
	private boolean fMakeNextButtonDefault;

	/**
	 * Creates a new refactoring wizard dialog with the given wizard.
	 * 
	 * @param parent the parent shell
	 * @param wizard the refactoring wizard
	 */
	public RefactoringWizardDialog(Shell parent, RefactoringWizard wizard) {
		super(parent, wizard);
		IDialogSettings settings= wizard.getDialogSettings();
		if (settings == null) {
			settings= RefactoringUIPlugin.getDefault().getDialogSettings();
			wizard.setDialogSettings(settings);
		}

		int width= 600;
		int height= 400;

		String settingsSectionId= DIALOG_SETTINGS + '.' + wizard.getRefactoring().getName();
		fSettings= settings.getSection(settingsSectionId);
		if (fSettings == null) {
			fSettings= new DialogSettings(settingsSectionId);
			settings.addSection(fSettings);
			fSettings.put(WIDTH, width);
			fSettings.put(HEIGHT, height);
		} else {
			try {
				width= fSettings.getInt(WIDTH);
				height= fSettings.getInt(HEIGHT);
			} catch (NumberFormatException e) {
			}
		}
		setMinimumPageSize(width, height);
	}

	/*
	 * @see org.eclipse.jface.dialogs.Dialog#isResizable()
	 * @since 3.4
	 */
	protected boolean isResizable() {
		return true;
	}

	/**
	 * {@inheritDoc}
	 */
	protected void configureShell(Shell newShell) {
		super.configureShell(newShell);
		getRefactoringWizard().getRefactoring().setValidationContext(newShell);
	}

	/**
	 * {@inheritDoc}
	 */
	protected void cancelPressed() {
		storeCurrentSize();

		//CODINGSPECTATOR: Record the time of pressing the cancel button.
		getRefactoringWizard().addNavigationHistoryItem(new NavigationHistoryItem(getCurrentPage().getName(), IDialogConstants.CANCEL_LABEL));

		super.cancelPressed();
	}

	/*
	 * @see WizardDialog#finishPressed()
	 */
	protected void finishPressed() {
		storeCurrentSize();

		//CODINGSPECTATOR: Record the time of pressing the finish button.
		getRefactoringWizard().addNavigationHistoryItem(new NavigationHistoryItem(getCurrentPage().getName(), IDialogConstants.FINISH_LABEL));

		super.finishPressed();
	}

	private void storeCurrentSize() {
		IWizardPage page= getCurrentPage();
		Control control= page.getControl().getParent();
		Point size= control.getSize();
		fSettings.put(WIDTH, size.x);
		fSettings.put(HEIGHT, size.y);
	}

	/*
	 * @see IWizardContainer#updateButtons()
	 */
	public void updateButtons() {
		super.updateButtons();
		if (!fMakeNextButtonDefault)
			return;
		if (getShell() == null)
			return;
		Button next= getButton(IDialogConstants.NEXT_ID);
		if (next.isEnabled())
			getShell().setDefaultButton(next);
	}

	/* usually called in the IWizard#setContainer(IWizardContainer) method
	 */
	public void makeNextButtonDefault() {
		fMakeNextButtonDefault= true;
	}

	/*
	 * @see org.eclipse.jface.wizard.WizardDialog#getButton(int)
	 */
	protected Button getButton(int id) {
		return super.getButton(id);
	}

	private RefactoringWizard getRefactoringWizard() {
		return (RefactoringWizard)getWizard();
	}

	/////////////////
	//CODINGSPECTATOR
	/////////////////

	/**
	 * FIXME: We don't know if this method ever gets invoked.
	 */
	protected void okPressed() {
		getRefactoringWizard().addNavigationHistoryItem(new NavigationHistoryItem(getCurrentPage().getName(), IDialogConstants.OK_LABEL));
		super.okPressed();
	}

	protected void nextPressed() {
		getRefactoringWizard().addNavigationHistoryItem(new NavigationHistoryItem(getCurrentPage().getName(), IDialogConstants.NEXT_LABEL));
		super.nextPressed();
	}

	protected void backPressed() {
		getRefactoringWizard().addNavigationHistoryItem(new NavigationHistoryItem(getCurrentPage().getName(), IDialogConstants.BACK_LABEL));
		super.backPressed();
	}

	protected void handleShellCloseEvent() {
		getRefactoringWizard().addNavigationHistoryItem(new NavigationHistoryItem(getCurrentPage().getName(), NavigationHistoryItem.QUIT_DIALOG_EVENT));
		super.handleShellCloseEvent();
	}

}