IntroduceParameterWizard.java

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

import org.eclipse.dltk.core.ModelException;
import org.eclipse.dltk.internal.javascript.corext.refactoring.ParameterInfo;
import org.eclipse.dltk.internal.javascript.corext.refactoring.code.IntroduceParameterRefactoring;
import org.eclipse.dltk.internal.ui.editor.ScriptSourceViewer;
import org.eclipse.dltk.internal.ui.refactoring.RefactoringMessages;
import org.eclipse.dltk.javascript.core.JavaScriptNature;
import org.eclipse.dltk.javascript.internal.ui.text.JavascriptSourceViewerConfiguration;
import org.eclipse.dltk.ui.DLTKUILanguageManager;
import org.eclipse.dltk.ui.IDLTKUILanguageToolkit;
import org.eclipse.dltk.ui.util.ExceptionHandler;
import org.eclipse.jface.dialogs.Dialog;
import org.eclipse.jface.layout.PixelConverter;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.text.Document;
import org.eclipse.ltk.core.refactoring.RefactoringStatus;
import org.eclipse.ltk.ui.refactoring.RefactoringWizard;
import org.eclipse.ltk.ui.refactoring.UserInputWizardPage;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Label;

public class IntroduceParameterWizard extends RefactoringWizard {

	public IntroduceParameterWizard(IntroduceParameterRefactoring ref) {
		super(ref, DIALOG_BASED_USER_INTERFACE | PREVIEW_EXPAND_FIRST_NODE);
		setDefaultPageTitle(RefactoringMessages.IntroduceParameterWizard_defaultPageTitle);
	}

	/*
	 * non java-doc
	 * 
	 * @see RefactoringWizard#addUserInputPages
	 */
	protected void addUserInputPages() {
		addPage(new IntroduceParameterInputPage(
				/*getIntroduceParameterRefactoring().guessParameterNames()*/));
	}

	/*private IntroduceParameterRefactoring getIntroduceParameterRefactoring() {
		return (IntroduceParameterRefactoring) getRefactoring();
	}*/

	private static class IntroduceParameterInputPage extends
			UserInputWizardPage {

		private static final String DESCRIPTION = RefactoringMessages.IntroduceParameterInputPage_description;
		public static final String PAGE_NAME = "IntroduceParameterInputPage";//$NON-NLS-1$
		//private String[] fParamNameProposals;

		private ScriptSourceViewer fSignaturePreview;
		private Document fSignaturePreviewDocument;
		//private Button fLeaveDelegateCheckBox;
		//private Button fDeprecateDelegateCheckBox;

		public IntroduceParameterInputPage(/*String[] tempNameProposals*/) {
			super(PAGE_NAME);
			setDescription(DESCRIPTION);
			//Assert.isNotNull(tempNameProposals);
			//fParamNameProposals = tempNameProposals;
			fSignaturePreviewDocument = new Document();
		}

		private IntroduceParameterRefactoring getIntroduceParameterRefactoring() {
			return (IntroduceParameterRefactoring) getRefactoring();
		}

		public void createControl(Composite parent) {
			Composite result = new Composite(parent, SWT.NONE);
			setControl(result);
			GridLayout layout = new GridLayout();
			result.setLayout(layout);

			createParameterTableControl(result);
			/*fLeaveDelegateCheckBox = DelegateUIHelper
					.generateLeaveDelegateCheckbox(result, getRefactoring(),
							false);
			if (fLeaveDelegateCheckBox != null) {
				fDeprecateDelegateCheckBox = new Button(result, SWT.CHECK);
				GridData data = new GridData();
				data.horizontalAlignment = GridData.FILL;
				data.horizontalIndent = (layout.marginWidth + fDeprecateDelegateCheckBox
						.computeSize(SWT.DEFAULT, SWT.DEFAULT).x);
				fDeprecateDelegateCheckBox.setLayoutData(data);
				fDeprecateDelegateCheckBox.setText(DelegateUIHelper
						.getDeprecateDelegateCheckBoxTitle());
				final IntroduceParameterRefactoring refactoring = getIntroduceParameterRefactoring();
				fDeprecateDelegateCheckBox.setSelection(DelegateUIHelper
						.loadDeprecateDelegateSetting(refactoring));
				refactoring.setDeprecateDelegates(fDeprecateDelegateCheckBox
						.getSelection());
				fDeprecateDelegateCheckBox
						.addSelectionListener(new SelectionAdapter() {
							public void widgetSelected(SelectionEvent e) {
								refactoring
										.setDeprecateDelegates(fDeprecateDelegateCheckBox
												.getSelection());
							}
						});
				fDeprecateDelegateCheckBox.setEnabled(fLeaveDelegateCheckBox
						.getSelection());
				fLeaveDelegateCheckBox
						.addSelectionListener(new SelectionAdapter() {
							public void widgetSelected(SelectionEvent e) {
								fDeprecateDelegateCheckBox
										.setEnabled(fLeaveDelegateCheckBox
												.getSelection());
							}
						});
			}*/
			Label sep = new Label(result, SWT.SEPARATOR | SWT.HORIZONTAL);
			sep.setLayoutData((new GridData(GridData.FILL_HORIZONTAL)));
			createSignaturePreview(result);

			update(false);
			Dialog.applyDialogFont(result);
			/*PlatformUI
					.getWorkbench()
					.getHelpSystem()
					.setHelp(getControl(),
							IJavaHelpContextIds.INTRODUCE_PARAMETER_WIZARD_PAGE);*/
		}

		private ChangeParametersControl createParameterTableControl(
				Composite composite) {
			String labelText = RefactoringMessages.IntroduceParameterWizard_parameters;
			ChangeParametersControl cp = new ChangeParametersControl(composite,
					SWT.NONE, labelText, new IParameterListChangeListener() {
						public void parameterChanged(ParameterInfo parameter) {
							update(true);
						}

						public void parameterListChanged() {
							update(true);
						}

						public void parameterAdded(ParameterInfo parameter) {
							update(true);
						}
					}, ChangeParametersControl.Mode.INTRODUCE_PARAMETER
					/*,fParamNameProposals*/);
			cp.setLayoutData(new GridData(GridData.FILL_BOTH));
			cp.setInput(getIntroduceParameterRefactoring().getParameterInfos());
			cp.editParameter(getIntroduceParameterRefactoring()
					.getAddedParameterInfo());
			return cp;
		}

		/*public void dispose() {
			DelegateUIHelper.saveLeaveDelegateSetting(fLeaveDelegateCheckBox);
			DelegateUIHelper
					.saveDeprecateDelegateSetting(fDeprecateDelegateCheckBox);
			super.dispose();
		}*/

		private void createSignaturePreview(Composite composite) {
			Label previewLabel = new Label(composite, SWT.NONE);
			previewLabel
					.setText(RefactoringMessages.ChangeSignatureInputPage_method_Signature_Preview);

			IDLTKUILanguageToolkit toolkit = DLTKUILanguageManager.getLanguageToolkit(JavaScriptNature.NATURE_ID);
			IPreferenceStore store = toolkit.getCombinedPreferenceStore();
			fSignaturePreview = new ScriptSourceViewer(composite, null, null,
					false, SWT.READ_ONLY | SWT.V_SCROLL | SWT.WRAP /*
																	 * |
																	 * SWT.BORDER
																	 */, store);
			fSignaturePreview.configure(new JavascriptSourceViewerConfiguration(
					toolkit.getTextTools().getColorManager(), store, null, null));
			fSignaturePreview.getTextWidget().setBackground(
					composite.getBackground());
			fSignaturePreview.setDocument(fSignaturePreviewDocument);
			fSignaturePreview.setEditable(false);

			// Layouting problems with wrapped text: see
			// https://bugs.eclipse.org/bugs/show_bug.cgi?id=9866
			Control signaturePreviewControl = fSignaturePreview.getControl();
			PixelConverter pixelConverter = new PixelConverter(
					signaturePreviewControl);
			GridData gdata = new GridData(GridData.FILL_BOTH);
			gdata.widthHint = pixelConverter.convertWidthInCharsToPixels(50);
			gdata.heightHint = pixelConverter.convertHeightInCharsToPixels(2);
			signaturePreviewControl.setLayoutData(gdata);
		}

		private void update(boolean displayErrorMessage) {
			updateStatus(displayErrorMessage);
			updateSignaturePreview();
		}

		private void updateStatus(boolean displayErrorMessage) {
			RefactoringStatus nameCheck = getIntroduceParameterRefactoring()
					.validateInput();
			if (displayErrorMessage) {
				setPageComplete(nameCheck);
			} else {
				setErrorMessage(null);
				setPageComplete(true);
			}
		}

		private void updateSignaturePreview() {
			try {
				int top = fSignaturePreview.getTextWidget().getTopPixel();
				fSignaturePreviewDocument
						.set(getIntroduceParameterRefactoring()
								.getMethodSignaturePreview());
				fSignaturePreview.getTextWidget().setTopPixel(top);
			} catch (ModelException e) {
				ExceptionHandler
						.handle(e,
								RefactoringMessages.IntroduceParameterWizard_defaultPageTitle,
								RefactoringMessages.ChangeSignatureInputPage_exception);
			}
		}

	}
}