Eclipse JDT
Release 3.8

org.eclipse.jdt.ui.actions
Class FormatAllAction

java.lang.Object
  extended by org.eclipse.core.commands.common.EventManager
      extended by org.eclipse.jface.action.AbstractAction
          extended by org.eclipse.jface.action.Action
              extended by org.eclipse.jdt.ui.actions.SelectionDispatchAction
                  extended by org.eclipse.jdt.ui.actions.FormatAllAction
All Implemented Interfaces:
IAction, ISelectionChangedListener

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 ICompilationUnit, IPackage , IPackageFragmentRoot/code> and IJavaProject.

This class may be instantiated; it is not intended to be subclassed.

Since:
3.0
Restriction:
This class is not intended to be subclassed by clients.

Nested Class Summary
static class FormatAllAction.ObjectDelegate
           
 
Field Summary
 
Fields inherited from interface org.eclipse.jface.action.IAction
AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT
 
Constructor Summary
FormatAllAction(IWorkbenchSite site)
          Creates a new FormatAllAction.
 
Method Summary
 void run(IStructuredSelection selection)
          Executes this actions with the given structured selection.
 void run(ITextSelection selection)
          Executes this actions with the given text selection.
 void runOnMultiple(ICompilationUnit[] cus)
          Perform format all on the given compilation units.
 void selectionChanged(IStructuredSelection selection)
          Notifies this action that the given structured selection has changed.
 void selectionChanged(ITextSelection selection)
          Notifies this action that the given text selection has changed.
 
Methods inherited from class org.eclipse.jdt.ui.actions.SelectionDispatchAction
getSelection, getSelectionProvider, getShell, getSite, run, run, run, selectionChanged, selectionChanged, selectionChanged, setSpecialSelectionProvider, update
 
Methods inherited from class org.eclipse.jface.action.Action
convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 
Methods inherited from class org.eclipse.jface.action.AbstractAction
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener
 
Methods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.jface.action.IAction
addPropertyChangeListener, removePropertyChangeListener
 

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 text selection has changed. This default implementation calls selectionChanged(ISelection selection).

Overrides:
selectionChanged in class SelectionDispatchAction
Parameters:
selection - the new selection

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(ITextSelection selection)
Description copied from class: SelectionDispatchAction
Executes this actions with the given text selection. This default implementation calls run(ISelection selection).

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 structured selection. This default implementation calls run(ISelection selection).

Overrides:
run in class SelectionDispatchAction
Parameters:
selection - the selection

runOnMultiple

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

Parameters:
cus - The compilation units to format.

Eclipse JDT
Release 3.8

Guidelines for using Eclipse APIs.

Copyright (c) 2000, 2013 IBM Corporation and others. All rights reserved.