JavaScript Development Tools
Release 3.2

org.eclipse.wst.jsdt.ui.actions
Class OverrideMethodsAction

java.lang.Object
  extended by Action
      extended by org.eclipse.wst.jsdt.ui.actions.SelectionDispatchAction
          extended by org.eclipse.wst.jsdt.ui.actions.OverrideMethodsAction

public class OverrideMethodsAction
extends SelectionDispatchAction

Adds unimplemented methods of a type. The action opens a dialog from which the user can choose the methods to be added.

Will open the parent compilation unit in a JavaScript editor. The result is unsaved, so the user can decide if the changes are acceptable.

The action is applicable to structured selections containing elements of type IType.

This class may be instantiated; it is not intended to be subclassed.

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.


Constructor Summary
OverrideMethodsAction(org.eclipse.wst.jsdt.internal.ui.javaeditor.CompilationUnitEditor editor)
          Note: This constructor is for internal use only.
 
Method Summary
static IWorkspaceRunnable createRunnable(JavaScriptUnit astRoot, ITypeBinding type, IFunctionBinding[] methodToOverride, int insertPos, boolean createComments)
          Returns a runnable that creates the method stubs for overridden methods.
 void run(IStructuredSelection selection)
          Executes this actions with the given structured selection.
 void selectionChanged(IStructuredSelection selection)
          Notifies this action that the given structured selection has changed.
 
Methods inherited from class org.eclipse.wst.jsdt.ui.actions.SelectionDispatchAction
getSelection, getSelectionProvider, getShell, getSite, run, setSpecialSelectionProvider, update
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OverrideMethodsAction

public OverrideMethodsAction(org.eclipse.wst.jsdt.internal.ui.javaeditor.CompilationUnitEditor editor)
Note: This constructor is for internal use only. Clients should not call this constructor.

Parameters:
editor - the compilation unit editor
Method Detail

run

public void run(IStructuredSelection selection)
Description copied from class: SelectionDispatchAction
Executes this actions with the given structured selection. This default implementation calls run(ISelection selection).

Overrides:
run in class SelectionDispatchAction
Parameters:
selection - the selection

createRunnable

public static IWorkspaceRunnable createRunnable(JavaScriptUnit astRoot,
                                                ITypeBinding type,
                                                IFunctionBinding[] methodToOverride,
                                                int insertPos,
                                                boolean createComments)
Returns a runnable that creates the method stubs for overridden methods.

Parameters:
astRoot - the AST of the compilation unit to work on. The AST must have been created from a IJavaScriptUnit, that means ASTParser.setSource(IJavaScriptUnit) was used.
type - the binding of the type to add the new methods to. The type binding must correspond to a type declaration in the AST.
methodToOverride - the bindings of methods to override or null to implement all unimplemented, abstract methods from super types.
insertPos - a hint for a location in the source where to insert the new methods or -1 to use the default behavior.
createComments - if set, comments will be added to the new methods.
Returns:
returns a runnable that creates the methods stubs.
Throws:
IllegalArgumentException - a IllegalArgumentException is thrown if the AST passed has not been created from a IJavaScriptUnit.

selectionChanged

public void selectionChanged(IStructuredSelection selection)
Description copied from class: SelectionDispatchAction
Notifies this action that the given structured selection has changed. This default implementation calls selectionChanged(ISelection selection).

Overrides:
selectionChanged in class SelectionDispatchAction
Parameters:
selection - the new selection

JavaScript Development Tools
Release 3.2

Copyright (c) IBM Corp. and others 2000, 2010. All Rights Reserved.