|
JavaScript Development Tools Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectAction
org.eclipse.wst.jsdt.ui.actions.SelectionDispatchAction
org.eclipse.wst.jsdt.ui.actions.AddJavaDocStubAction
public class AddJavaDocStubAction
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 |
---|
public AddJavaDocStubAction(IWorkbenchSite site)
AddJavaDocStubAction
. The action requires
that the selection provided by the site's selection provider is of type
org.eclipse.jface.viewers.IStructuredSelection
.
site
- the site providing context information for this actionMethod Detail |
---|
public void selectionChanged(IStructuredSelection selection)
SelectionDispatchAction
selectionChanged(ISelection selection)
.
selectionChanged
in class SelectionDispatchAction
selection
- the new selectionpublic void run(IStructuredSelection selection)
SelectionDispatchAction
run(ISelection selection)
.
run
in class SelectionDispatchAction
selection
- the selectionpublic void run(IJavaScriptUnit cu, IMember[] members)
cu
- the compilation unitmembers
- an array of members
|
JavaScript Development Tools Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |