public class RenameResourceAction extends WorkspaceAction
This class may be instantiated; it is not intended to be subclassed.
| Modifier and Type | Field and Description |
|---|---|
static String |
ID
The id of this action.
|
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 and 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.
|
| Modifier and Type | Method and Description |
|---|---|
protected IRunnableWithProgress |
createOperation(IStatus[] errorStatus)
Returns the operation to perform when this action runs.
|
protected List |
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 String |
getOperationMessage()
Returns the string to display for this action's operation.
|
protected String |
getProblemsMessage()
Returns the string to display for this action's problems dialog.
|
protected String |
getProblemsTitle()
Returns the title for this action's problems dialog.
|
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 |
setModelProviderIds(String[] modelProviderIds)
Sets the model provider ids that are known to the client that
instantiated this operation.
|
void |
setTextActionHandler(TextActionHandler actionHandler)
Set the text action handler.
|
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. |
invokeOperation, runInBackground, runInBackground, runInBackground, shouldPerformResourcePruningclearCache, getSelectedNonResources, getSelectedResources, resourceIsType, selectionIsOfTypegetStructuredSelection, runWithEvent, selectionChanged, selectionChangedconvertAccelerator, 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, setToolTipTextaddPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListeneraddListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObjectpublic static final String ID
public RenameResourceAction(Shell shell)
RenameResourceAction(IShellProvider)shell - the shell for any dialogspublic RenameResourceAction(IShellProvider provider)
provider - the IShellProvider for any dialogspublic RenameResourceAction(Shell shell, Tree tree)
RenameResourceAction(IShellProvider, Tree)shell - the shell for any dialogstree - the treepublic RenameResourceAction(IShellProvider provider, Tree tree)
provider - the shell provider for any dialogstree - the treeprotected List getActionResources()
getActionResources in class WorkspaceActionIResource)protected String getOperationMessage()
WorkspaceActionNote that this hook method is invoked in a non-UI thread.
Subclasses must implement this method.
getOperationMessage in class WorkspaceActionprotected String getProblemsMessage()
WorkspaceAction
The WorkspaceAction implementation 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.
getProblemsMessage in class WorkspaceActionprotected String getProblemsTitle()
WorkspaceAction
The WorkspaceAction implementation of this method returns
a generic title (localized counterpart of "Problems"). Subclasses may
reimplement to provide something more suited to the particular action.
getProblemsTitle in class WorkspaceActionprotected String queryNewResourceName(IResource resource)
resource - the resource to query status onpublic void run()
WorkspaceActionCoreWrapperAction 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.
run in interface IActionrun in class WorkspaceActionHow radio buttons are handled,
How check boxes are handledprotected void runWithNewPath(IPath path, IResource resource)
path - the pathresource - the resourceprotected boolean updateSelection(IStructuredSelection selection)
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.updateSelection in class WorkspaceActionselection - the new selectiontrue if the action should be enabled for this selection,
and false otherwisepublic void setTextActionHandler(TextActionHandler actionHandler)
actionHandler - the action handlerpublic String[] getModelProviderIds()
public void setModelProviderIds(String[] modelProviderIds)
modelProviderIds - the model providers known to the client who is using this
operation.protected IRunnableWithProgress createOperation(IStatus[] errorStatus)
WorkspaceActionIRunnableWithProgress that will perform the
action's work. The default implementation returns an operation that will
iterate over the selected resources and call
WorkspaceAction.invokeOperation(IResource, IProgressMonitor) for each resource.
Subclasses must either implement
WorkspaceAction.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.createOperation in class WorkspaceActionerrorStatus - an array of error status objects to which the result of
running the operation should be added.
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.