content: /*******************************************************************************
   * 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.wst.jsdt.ui.actions;
  
  
  import org.eclipse.jface.dialogs.MessageDialog;
  import org.eclipse.jface.text.ITextSelection;
  import org.eclipse.jface.viewers.IStructuredSelection;
  import org.eclipse.ui.IWorkbenchSite;
  import org.eclipse.ui.PlatformUI;
  import org.eclipse.wst.jsdt.core.IField;
  import org.eclipse.wst.jsdt.core.IJavaScriptElement;
  import org.eclipse.wst.jsdt.core.JavaScriptModelException;
  import org.eclipse.wst.jsdt.internal.corext.refactoring.RefactoringAvailabilityTester;
  import org.eclipse.wst.jsdt.internal.corext.refactoring.RefactoringExecutionStarter;
  import org.eclipse.wst.jsdt.internal.corext.util.JavaModelUtil;
  import org.eclipse.wst.jsdt.internal.ui.IJavaHelpContextIds;
  import org.eclipse.wst.jsdt.internal.ui.JavaScriptPlugin;
  import org.eclipse.wst.jsdt.internal.ui.actions.ActionMessages;
  import org.eclipse.wst.jsdt.internal.ui.actions.ActionUtil;
  import org.eclipse.wst.jsdt.internal.ui.actions.SelectionConverter;
  import org.eclipse.wst.jsdt.internal.ui.javaeditor.JavaEditor;
  import org.eclipse.wst.jsdt.internal.ui.javaeditor.JavaTextSelection;
  import org.eclipse.wst.jsdt.internal.ui.refactoring.RefactoringMessages;
  import org.eclipse.wst.jsdt.internal.ui.util.ExceptionHandler;
  
  /**
   * Action to run the self encapsulate field refactoring. 
   * <p>
   * Action is applicable to selections containing elements of type
   * <code>IField</code>.
   * 
   * <p>
   * This class may be instantiated; it is not intended to be subclassed.
   * </p>
   * 
   *
   * Provisional API: This class/interface is part of an interim API that is still under development and expected to
   * change significantly before reaching stability. It is being made available at this early stage to solicit feedback
   * from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken
   * (repeatedly) as the API evolves.
   */
  public class SelfEncapsulateFieldAction extends SelectionDispatchAction {
  	
  	private JavaEditor fEditor;
  	
  	/**
  	 * Creates a new <code>SelfEncapsulateFieldAction</code>. The action requires 
  	 * that the selection provided by the site's selection provider is of type <code>
  	 * org.eclipse.jface.viewers.IStructuredSelection</code>.
  	 * 
  	 * @param site the site providing context information for this action
  	 */
  	public SelfEncapsulateFieldAction(IWorkbenchSite site) {
  		super(site);
  		setText(ActionMessages.SelfEncapsulateFieldAction_label); 
  		PlatformUI.getWorkbench().getHelpSystem().setHelp(this, IJavaHelpContextIds.SELF_ENCAPSULATE_ACTION);
  	}
  	
  	/**
  	 * Note: This constructor is for internal use only. Clients should not call this constructor.
  	 * 
  	 * @param editor the JavaScript editor
  	 */
  	public SelfEncapsulateFieldAction(JavaEditor editor) {
  		this(editor.getEditorSite());
  		fEditor= editor;
  		setEnabled(SelectionConverter.canOperateOn(fEditor));
  	}
  	
  	//---- text selection -------------------------------------------------------
  	
  	/* (non-Javadoc)
  	 * Method declared on SelectionDispatchAction.
  	 */
  	public void selectionChanged(ITextSelection selection) {
  		setEnabled(true);
  	}
  	
  	/**
  	 * Note: This method is for internal use only. Clients should not call this method.
  	 */
  	public void selectionChanged(JavaTextSelection selection) {
  		try {
  			setEnabled(RefactoringAvailabilityTester.isSelfEncapsulateAvailable(selection));
  		} catch (JavaScriptModelException e) {
  			// http://bugs.eclipse.org/bugs/show_bug.cgi?id=19253
  			if (JavaModelUtil.isExceptionToBeLogged(e))
  				JavaScriptPlugin.log(e);
  			setEnabled(false);//no UI
  		}
  	}
  	
  	/* (non-Javadoc)
  	 * Method declared on SelectionDispatchAction.
  	 */
  	public void run(ITextSelection selection) {
  		try {
  			IJavaScriptElement[] elements= SelectionConverter.codeResolve(fEditor); 
  			if (elements.length != 1 || !(elements[0] instanceof IField)) {
  				MessageDialog.openInformation(getShell(), ActionMessages.SelfEncapsulateFieldAction_dialog_title, ActionMessages.SelfEncapsulateFieldAction_dialog_unavailable); 
  				return;
  			}
  			IField field= (IField)elements[0];
  
  			if (!RefactoringAvailabilityTester.isSelfEncapsulateAvailable(field)) {
  				MessageDialog.openInformation(getShell(), ActionMessages.SelfEncapsulateFieldAction_dialog_title, ActionMessages.SelfEncapsulateFieldAction_dialog_unavailable); 
  				return;
  			}
  			run(field);
  		} catch (JavaScriptModelException exception) {
  			JavaScriptPlugin.log(exception);
  			return;
  		}
  	}
  	
  	//---- structured selection -------------------------------------------------
  
  	/* (non-Javadoc)
  	 * Method declared on SelectionDispatchAction.
  	 */
  	public void selectionChanged(IStructuredSelection selection) {
  		try {
  			setEnabled(RefactoringAvailabilityTester.isSelfEncapsulateAvailable(selection));
  		} catch (JavaScriptModelException e) {
  			// http://bugs.eclipse.org/bugs/show_bug.cgi?id=19253
  			if (JavaModelUtil.isExceptionToBeLogged(e))
  				JavaScriptPlugin.log(e);
  			setEnabled(false);//no UI
  		}
  	}
  	
  	/*
  	 * (non-Javadoc)
  	 * Method declared on SelectionDispatchAction.
  	 */
  	public void run(IStructuredSelection selection) {
  		try {
  			if (RefactoringAvailabilityTester.isSelfEncapsulateAvailable(selection))
  				run((IField) selection.getFirstElement());
  		} catch (JavaScriptModelException e) {
  			ExceptionHandler.handle(e, RefactoringMessages.OpenRefactoringWizardAction_refactoring, RefactoringMessages.OpenRefactoringWizardAction_exception); 
  		}
  	}
  	
  	//---- private helpers --------------------------------------------------------
  	
  	/*
  	 * Should be private. But got shipped in this state in 2.0 so changing this is a
  	 * breaking API change.
  	 */
  	public void run(IField field) {
  		if (! ActionUtil.isEditable(fEditor, getShell(), field))
  			return;
  		RefactoringExecutionStarter.startSelfEncapsulateRefactoring(field, getShell());
  	}
  }
  