org.eclipse.ui.actions
Class RenameResourceAction

java.lang.Object
  |
  +--org.eclipse.jface.action.Action
        |
        +--org.eclipse.ui.actions.SelectionListenerAction
              |
              +--org.eclipse.ui.actions.WorkspaceAction
                    |
                    +--org.eclipse.ui.actions.RenameResourceAction

All Implemented Interfaces:

IAction, ISelectionChangedListener

Direct Known Subclasses:

ResourceNavigatorRenameAction

public class RenameResourceAction

extends WorkspaceAction

Standard action for renaming the selected resources.

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

Field Summary

static String

ID The id of this action.

Fields inherited from interface org.eclipse.jface.action.IAction

AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, CHECKED, DESCRIPTION, ENABLED, IMAGE, TEXT, TOOL_TIP_TEXT

Constructor Summary

RenameResourceAction(Shell shell)
Creates a new action.

RenameResourceAction(Shell shell, Tree tree)
Creates a new action.

Method Summary

protected List	getActionResources() Returns the elements that the action is to be performed on.
protected String	queryNewResourceName(IResource resource) Return the new name to be given to the target resource.
void	run() The CoreWrapperAction implementation of this IAction method uses a ProgressMonitorDialog to run the operation.
protected void	runWithNewPath(IPath path, IResource resource)
void	setTextActionHandler(TextActionHandler actionHandler)
protected boolean	updateSelection(IStructuredSelection selection) The RenameResourceAction implementation of this SelectionListenerAction method ensures that this action is disabled if any of the selections are not resources or resources that are not local.

Methods inherited from class org.eclipse.ui.actions.SelectionListenerAction

getSelectedNonResources, getSelectedResources, getStructuredSelection, resourceIsType, selectionChanged, selectionChanged, selectionIsOfType

Methods inherited from class org.eclipse.jface.action.Action

addPropertyChangeListener, convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, firePropertyChange, firePropertyChange, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, removeAcceleratorText, removePropertyChangeListener, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID

public static final String ID

The id of this action.

See Also:

Constant Field Values

Constructor Detail

RenameResourceAction

public RenameResourceAction(Shell shell)

Creates a new action. Using this constructor directly will rename using a dialog rather than the inline editor of a ResourceNavigator.

Parameters:

shell - the shell for any dialogs

RenameResourceAction

public RenameResourceAction(Shell shell,
                            Tree tree)

Creates a new action.

Parameters:

shell - the shell for any dialogs

Method Detail

queryNewResourceName

protected String queryNewResourceName(IResource resource)

Return the new name to be given to the target resource.

Returns:

java.lang.String

run

public void run()

Description copied from class: WorkspaceAction

The CoreWrapperAction implementation of this IAction method uses a ProgressMonitorDialog to run the operation. The operation calls execute (which, in turn, calls invokeOperation). Afterwards, any CoreExceptions encountered while running the operation are reported to the user via a problems dialog.

Subclasses may extend this method.

Specified by:

run in interface IAction

Overrides:

run in class WorkspaceAction

runWithNewPath

protected void runWithNewPath(IPath path,
                              IResource resource)

updateSelection

protected boolean updateSelection(IStructuredSelection selection)

The RenameResourceAction implementation of this SelectionListenerAction method ensures that this action is disabled if any of the selections are not resources or resources that are not local.

Overrides:

updateSelection in class WorkspaceAction

Parameters:

selection - the new selection

Returns:

true if the action should be enabled for this selection, and false otherwise

setTextActionHandler

public void setTextActionHandler(TextActionHandler actionHandler)

getActionResources

protected List getActionResources()

Returns the elements that the action is to be performed on. Return the resource cached by the action as we cannot rely on the selection being correct for inlined text.

Overrides:

getActionResources in class WorkspaceAction

Returns:

list of resource elements (element type: IResource)