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

java.lang.Object
  Action
      org.eclipse.wst.jsdt.ui.actions.SelectionDispatchAction
          org.eclipse.wst.jsdt.ui.actions.AddUnimplementedConstructorsAction

public class AddUnimplementedConstructorsAction
extends SelectionDispatchAction

Creates unimplemented constructors for a type.

Will open the parent compilation unit in a JavaScript editor. Opens a dialog with a list of constructors from the super class which can be generated. User is able to check or uncheck items before constructors are generated. 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

AddUnimplementedConstructorsAction(org.eclipse.wst.jsdt.internal.ui.javaeditor.CompilationUnitEditor editor)
Note: This constructor is for internal use only.

AddUnimplementedConstructorsAction(IWorkbenchSite site)
Creates a new AddUnimplementedConstructorsAction.

Method Summary

static IWorkspaceRunnable	createRunnable(JavaScriptUnit astRoot, ITypeBinding type, IFunctionBinding[] constructorsToOverride, int insertPos, boolean createComments, int visibility, boolean omitSuper) Returns a runnable that creates the constructor stubs.
void	run(IStructuredSelection selection) Executes this actions with the given selection.
void	run(ITextSelection selection) Executes this actions with the given selection.
void	selectionChanged(IStructuredSelection selection)
void	selectionChanged(ITextSelection selection)

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

AddUnimplementedConstructorsAction

public AddUnimplementedConstructorsAction(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

AddUnimplementedConstructorsAction

public AddUnimplementedConstructorsAction(IWorkbenchSite site)

Creates a new AddUnimplementedConstructorsAction. The action requires that the selection provided by the site's selection provider is of type org.eclipse.jface.viewers.IStructuredSelection.

Parameters:

site - the site providing context information for this action

Method Detail

run

public void run(IStructuredSelection selection)

Description copied from class: SelectionDispatchAction

Executes this actions with the given selection. This default implementation does nothing.

Overrides:

run in class SelectionDispatchAction

Parameters:

selection - the selection

run

public void run(ITextSelection selection)

Description copied from class: SelectionDispatchAction

Executes this actions with the given selection. This default implementation does nothing.

Overrides:

run in class SelectionDispatchAction

Parameters:

selection - the selection

createRunnable

public static IWorkspaceRunnable createRunnable(JavaScriptUnit astRoot,
                                                ITypeBinding type,
                                                IFunctionBinding[] constructorsToOverride,
                                                int insertPos,
                                                boolean createComments,
                                                int visibility,
                                                boolean omitSuper)

Returns a runnable that creates the constructor stubs.

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.

constructorsToOverride - the bindings of constructors to override or null to implement all visible constructors from the super class.

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.

visibility - the visibility for the new modifiers. (see Flags) for visibility constants.

omitSuper - if set, no super() call without arguments will be created.

Returns:

returns a runnable that creates the constructor stubs.

Throws:

IllegalArgumentException - a IllegalArgumentException is thrown if the AST passed has not been created from a IJavaScriptUnit.

selectionChanged

public void selectionChanged(IStructuredSelection selection)

Overrides:

selectionChanged in class SelectionDispatchAction

selectionChanged

public void selectionChanged(ITextSelection selection)

Overrides:

selectionChanged in class SelectionDispatchAction