Eclipse JDT
Release 3.7

org.eclipse.jdt.ui.actions
Class RenameAction

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.RenameAction
All Implemented Interfaces:
IAction, ISelectionChangedListener

public class RenameAction
extends SelectionDispatchAction

Renames a Java element or workbench resource.

Action is applicable to selections containing elements of type IJavaElement or IResource.

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

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

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
RenameAction(IWorkbenchSite site)
          Creates a new RenameAction.
RenameAction(org.eclipse.jdt.internal.ui.javaeditor.JavaEditor editor)
          Note: This constructor is for internal use only.
 
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 selectionChanged(SelectionChangedEvent event)
           
 void update(ISelection selection)
          Updates the action's enablement state according to the given selection.
 
Methods inherited from class org.eclipse.jdt.ui.actions.SelectionDispatchAction
getSelection, getSelectionProvider, getShell, getSite, run, run, run, selectionChanged, selectionChanged, selectionChanged, selectionChanged, setSpecialSelectionProvider
 
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

RenameAction

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

RenameAction

public RenameAction(org.eclipse.jdt.internal.ui.javaeditor.JavaEditor editor)
Note: This constructor is for internal use only. Clients should not call this constructor.

Parameters:
editor - the Java editor
Restriction:
This constructor is not intended to be referenced by clients.
Method Detail

selectionChanged

public void selectionChanged(SelectionChangedEvent event)
Specified by:
selectionChanged in interface ISelectionChangedListener
Overrides:
selectionChanged in class SelectionDispatchAction

update

public void update(ISelection selection)
Description copied from class: SelectionDispatchAction
Updates the action's enablement state according to the given selection. This default implementation calls one of the selectionChanged methods depending on the type of the passed selection.

Overrides:
update in class SelectionDispatchAction
Parameters:
selection - the selection this action is working on

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

Eclipse JDT
Release 3.7

Guidelines for using Eclipse APIs.

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