/*
 * Copyright (c) 2012, the Dart project authors.
 * 
 * Licensed under the Eclipse Public License v1.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.google.dart.tools.ui.internal.refactoring.reorg;

import com.google.dart.tools.internal.corext.refactoring.tagging.INameUpdating;
import com.google.dart.tools.ui.DartToolsPlugin;
import com.google.dart.tools.ui.internal.refactoring.RefactoringMessages;
import com.google.dart.tools.ui.internal.refactoring.ServiceRefactoring;
import com.google.dart.tools.ui.internal.refactoring.ServiceRefactoringWizard;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.ltk.core.refactoring.RefactoringStatus;

/**
 * @coverage dart.editor.ui.refactoring.ui
 */
public class RenameRefactoringWizard extends ServiceRefactoringWizard {

  private final String fInputPageDescription;
  private final String fPageContextHelpId;
  private final ImageDescriptor fInputPageImageDescriptor;

  // dialog settings constants:

  /**
   * Dialog settings key (value is of type boolean).
   */
  public static final String UPDATE_TEXTUAL_MATCHES = "updateTextualMatches"; //$NON-NLS-1$
  /**
   * Dialog settings key (value is of type boolean).
   */
  public static final String UPDATE_QUALIFIED_NAMES = "updateQualifiedNames"; //$NON-NLS-1$
  /**
   * Dialog settings key (value is of type String).
   */
  public static final String QUALIFIED_NAMES_PATTERNS = "patterns"; //$NON-NLS-1$

  /**
   * Dialog settings key (value is of type boolean).
   */
  public static final String TYPE_UPDATE_SIMILAR_ELEMENTS = "updateSimilarElements"; //$NON-NLS-1$
  /**
   * Dialog settings key (value is of type int).
   * 
   * @see RenamingNameSuggestor
   */
  public static final String TYPE_SIMILAR_MATCH_STRATEGY = "updateSimilarElementsMatchStrategy"; //$NON-NLS-1$

  /**
   * Dialog settings key (value is of type boolean).
   */
  public static final String FIELD_RENAME_GETTER = "renameGetter"; //$NON-NLS-1$
  /**
   * Dialog settings key (value is of type boolean).
   */
  public static final String FIELD_RENAME_SETTER = "renameSetter"; //$NON-NLS-1$

  public RenameRefactoringWizard(ServiceRefactoring refactoring, String defaultPageTitle,
      String inputPageDescription, ImageDescriptor inputPageImageDescriptor,
      String pageContextHelpId) {
    super(refactoring, DIALOG_BASED_USER_INTERFACE);
    setDefaultPageTitle(defaultPageTitle);
    fInputPageDescription = inputPageDescription;
    fInputPageImageDescriptor = inputPageImageDescriptor;
    fPageContextHelpId = pageContextHelpId;
    setDialogSettings(DartToolsPlugin.getDefault().getDialogSettings());
  }

  @Override
  protected void addUserInputPages() {
    String initialSetting = getNameUpdating().getCurrentElementName();
    RenameInputWizardPage inputPage = createInputPage(fInputPageDescription, initialSetting);
    inputPage.setImageDescriptor(fInputPageImageDescriptor);
    addPage(inputPage);
  }

  protected RenameInputWizardPage createInputPage(String message, String initialSetting) {
    return new RenameInputWizardPage(message, fPageContextHelpId, true, initialSetting) {
      @Override
      protected RefactoringStatus validateTextField(String text) {
        return validateNewName(text);
      }
    };
  }

  /**
   * Sets a new name, validates the input, and returns the status.
   * 
   * @param newName the new name
   * @return validation status
   */
  protected RefactoringStatus validateNewName(String newName) {
    INameUpdating ref = getNameUpdating();
    ref.setNewElementName(newName);
    try {
      return ref.checkNewElementName(newName);
    } catch (CoreException e) {
      DartToolsPlugin.log(e);
      return RefactoringStatus.createFatalErrorStatus(RefactoringMessages.RenameRefactoringWizard_internal_error);
    }
  }

  private INameUpdating getNameUpdating() {
    return (INameUpdating) getRefactoring().getAdapter(INameUpdating.class);
  }
}