JavaScript Development Tools
Release 3.2

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

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

public class AddJavaDocStubAction
extends SelectionDispatchAction

Create Javadoc comment stubs for the selected members.

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 IMember.

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
AddJavaDocStubAction(IWorkbenchSite site)
          Creates a new AddJavaDocStubAction.
 
Method Summary
 void run(IJavaScriptUnit cu, IMember[] members)
          Note this method is for internal use only.
 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

AddJavaDocStubAction

public AddJavaDocStubAction(IWorkbenchSite site)
Creates a new AddJavaDocStubAction. 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

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

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

run

public void run(IJavaScriptUnit cu,
                IMember[] members)
Note this method is for internal use only.

Parameters:
cu - the compilation unit
members - an array of members

JavaScript Development Tools
Release 3.2

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