Package org.eclipse.ui.actions
Class 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.
- Restriction:
- This class is not intended to be subclassed by clients.
-
-
Field Summary
Fields Modifier and Type Field Description static StringIDThe id of this action.-
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
Constructors Constructor Description RenameResourceAction(IShellProvider provider)Creates a new action.RenameResourceAction(IShellProvider provider, Tree tree)Creates a new action.RenameResourceAction(Shell shell)Deprecated.RenameResourceAction(Shell shell, Tree tree)Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected IRunnableWithProgresscreateOperation(IStatus[] errorStatus)Returns the operation to perform when this action runs.protected List<? extends IResource>getActionResources()Returns the elements that the action is to be performed on.String[]getModelProviderIds()Returns the model provider ids that are known to the client that instantiated this operation.protected StringgetOperationMessage()Returns the string to display for this action's operation.protected StringgetProblemsMessage()Returns the string to display for this action's problems dialog.protected StringgetProblemsTitle()Returns the title for this action's problems dialog.protected StringqueryNewResourceName(IResource resource)Return the new name to be given to the target resource.voidrun()TheCoreWrapperActionimplementation of thisIActionmethod uses aProgressMonitorDialogto run the operation.protected voidrunWithNewPath(IPath path, IResource resource)voidsetModelProviderIds(String[] modelProviderIds)Sets the model provider ids that are known to the client that instantiated this operation.voidsetTextActionHandler(TextActionHandler actionHandler)Set the text action handler.protected booleanupdateSelection(IStructuredSelection selection)TheRenameResourceActionimplementation of thisSelectionListenerActionmethod 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.WorkspaceAction
invokeOperation, runInBackground, runInBackground, runInBackground, shouldPerformResourcePruning
-
Methods inherited from class org.eclipse.ui.actions.SelectionListenerAction
clearCache, getSelectedNonResources, getSelectedResources, resourceIsType, selectionIsOfType
-
Methods inherited from class org.eclipse.ui.actions.BaseSelectionListenerAction
getStructuredSelection, runWithEvent, selectionChanged, selectionChanged
-
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, 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
-
-
-
-
Field Detail
-
ID
public static final String ID
The id of this action.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
RenameResourceAction
@Deprecated public RenameResourceAction(Shell shell)
Deprecated.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(IShellProvider provider)
Creates a new action. Using this constructor directly will rename using a dialog rather than the inline editor of a ResourceNavigator.- Parameters:
provider- the IShellProvider for any dialogs- Since:
- 3.4
-
RenameResourceAction
@Deprecated public RenameResourceAction(Shell shell, Tree tree)
Deprecated.Creates a new action.- Parameters:
shell- the shell for any dialogstree- the tree
-
RenameResourceAction
public RenameResourceAction(IShellProvider provider, Tree tree)
Creates a new action.- Parameters:
provider- the shell provider for any dialogstree- the tree- Since:
- 3.4
-
-
Method Detail
-
getActionResources
protected List<? extends IResource> 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:
getActionResourcesin classWorkspaceAction- Returns:
- list of resource elements (element type:
IResource)
-
getOperationMessage
protected String getOperationMessage()
Description copied from class:WorkspaceActionReturns the string to display for this action's operation.Note that this hook method is invoked in a non-UI thread.
Subclasses must implement this method.
- Specified by:
getOperationMessagein classWorkspaceAction- Returns:
- the message
-
getProblemsMessage
protected String getProblemsMessage()
Description copied from class:WorkspaceActionReturns the string to display for this action's problems dialog.The
WorkspaceActionimplementation of this method returns a vague message (localized counterpart of something like "The following problems occurred."). Subclasses may reimplement to provide something more suited to the particular action.- Overrides:
getProblemsMessagein classWorkspaceAction- Returns:
- the problems message
-
getProblemsTitle
protected String getProblemsTitle()
Description copied from class:WorkspaceActionReturns the title for this action's problems dialog.The
WorkspaceActionimplementation of this method returns a generic title (localized counterpart of "Problems"). Subclasses may reimplement to provide something more suited to the particular action.- Overrides:
getProblemsTitlein classWorkspaceAction- Returns:
- the problems dialog title
-
queryNewResourceName
protected String queryNewResourceName(IResource resource)
Return the new name to be given to the target resource.- Parameters:
resource- the resource to query status on- Returns:
- java.lang.String
-
run
public void run()
Description copied from class:WorkspaceActionTheCoreWrapperActionimplementation of thisIActionmethod uses aProgressMonitorDialogto run the operation. The operation callsexecute(which, in turn, callsinvokeOperation). Afterwards, anyCoreExceptions encountered while running the operation are reported to the user via a problems dialog.Subclasses may extend this method.
- Specified by:
runin interfaceIAction- Overrides:
runin classWorkspaceAction- See Also:
How radio buttons are handled,How check boxes are handled
-
runWithNewPath
protected void runWithNewPath(IPath path, IResource resource)
- Parameters:
path- the pathresource- the resource
-
updateSelection
protected boolean updateSelection(IStructuredSelection selection)
TheRenameResourceActionimplementation of thisSelectionListenerActionmethod ensures that this action is disabled if any of the selections are not resources or resources that are not local.- Overrides:
updateSelectionin classWorkspaceAction- Parameters:
selection- the new selection- Returns:
trueif the action should be enabled for this selection, andfalseotherwise
-
setTextActionHandler
public void setTextActionHandler(TextActionHandler actionHandler)
Set the text action handler.- Parameters:
actionHandler- the action handler
-
getModelProviderIds
public String[] getModelProviderIds()
Returns the model provider ids that are known to the client that instantiated this operation.- Returns:
- the model provider ids that are known to the client that instantiated this operation.
- Since:
- 3.2
-
setModelProviderIds
public void setModelProviderIds(String[] modelProviderIds)
Sets the model provider ids that are known to the client that instantiated this operation. Any potential side effects reported by these models during validation will be ignored.- Parameters:
modelProviderIds- the model providers known to the client who is using this operation.- Since:
- 3.2
-
createOperation
protected IRunnableWithProgress createOperation(IStatus[] errorStatus)
Description copied from class:WorkspaceActionReturns the operation to perform when this action runs. The returned operation must be anIRunnableWithProgressthat will perform the action's work. The default implementation returns an operation that will iterate over the selected resources and callWorkspaceAction.invokeOperation(IResource, IProgressMonitor)for each resource. Subclasses must either implementWorkspaceAction.invokeOperation(IResource, IProgressMonitor)or override this method to provide a different operation. Subclasses typically override this method when an undoable operation is to be provided.- Overrides:
createOperationin classWorkspaceAction- Parameters:
errorStatus- an array of error status objects to which the result of running the operation should be added.- Returns:
- the operation to perform when this action runs.
-
-