JavaScript Development Tools
Release 3.2

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

java.lang.Object
  extended by Action
      extended by org.eclipse.wst.jsdt.ui.actions.SelectionDispatchAction
          extended by 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(ITextSelection selection)
          Executes this actions with the given structured selection.
 void runOnMultiple(IJavaScriptUnit[] cus)
          Perform format all on the given compilation units.
 void selectionChanged(ITextSelection 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

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)
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(ITextSelection 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

runOnMultiple

public void runOnMultiple(IJavaScriptUnit[] cus)
Perform format all on the given compilation units.

Parameters:
cus - The compilation units to format.

JavaScript Development Tools
Release 3.2

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