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

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

public class FormatAllAction
extends SelectionDispatchAction

Formats the code of the compilation units contained in the selection.

The action is applicable to selections containing elements of type IJavaScriptUnit, IPackage , IPackageFragmentRoot/code> and IJavaScriptProject.

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.

Nested Class Summary

static class

FormatAllAction.ObjectDelegate

Constructor Summary

FormatAllAction(IWorkbenchSite site)
Creates a new FormatAllAction.

Method Summary

void	run(IStructuredSelection selection) Executes this actions with the given selection.
void	run(ITextSelection selection) Executes this actions with the given selection.
void	runOnMultiple(IJavaScriptUnit[] cus) Perform format all on the given compilation units.
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

FormatAllAction

public FormatAllAction(IWorkbenchSite site)

Creates a new FormatAllAction. 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(ITextSelection selection)

Overrides:

selectionChanged in class SelectionDispatchAction

selectionChanged

public void selectionChanged(IStructuredSelection selection)

Overrides:

selectionChanged in class SelectionDispatchAction

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

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

runOnMultiple

public void runOnMultiple(IJavaScriptUnit[] cus)

Perform format all on the given compilation units.

Parameters:

cus - The compilation units to format.