|
 |
|
| |
org.eclipse.ui.actions
Class RenameResourceAction
java.lang.Object
org.eclipse.core.commands.common.EventManager
org.eclipse.jface.action.AbstractAction
org.eclipse.jface.action.Action
org.eclipse.ui.actions.BaseSelectionListenerAction
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.
-
Restriction:
- This class is not intended to be subclassed by clients.
|
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,
AS_RADIO_BUTTON,
AS_UNSPECIFIED,
CHECKED,
DESCRIPTION,
ENABLED,
HANDLED,
IMAGE,
RESULT,
TEXT,
TOOL_TIP_TEXT
|
|
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 java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
ID
public static final
String ID
- The id of this action.
-
See Also:
-
Constant Field Values
RenameResourceAction
public RenameResourceAction(
Shell shell)
-
Deprecated. see
RenameResourceAction(IShellProvider)
- 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
public RenameResourceAction(
Shell shell,
Tree tree)
-
Deprecated. see
RenameResourceAction(IShellProvider, Tree)
- Creates a new action.
-
Parameters:
-
shell - the shell for any dialogs -
tree - the tree
RenameResourceAction
public RenameResourceAction(
IShellProvider provider,
Tree tree)
- Creates a new action.
-
Parameters:
-
provider - the shell provider for any dialogs -
tree - the tree -
Since:
- 3.4
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)
getOperationMessage
protected
String getOperationMessage()
-
Description copied from class:
WorkspaceAction
- Returns 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:
-
getOperationMessage
in class
WorkspaceAction
-
-
Returns:
- the message
getProblemsMessage
protected
String getProblemsMessage()
-
Description copied from class:
WorkspaceAction
- Returns the string to display for this action's problems dialog.
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.
-
-
Overrides:
-
getProblemsMessage
in class
WorkspaceAction
-
-
Returns:
- the problems message
getProblemsTitle
protected
String getProblemsTitle()
-
Description copied from class:
WorkspaceAction
- Returns the title for this action's problems dialog.
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.
-
-
Overrides:
-
getProblemsTitle
in class
WorkspaceAction
-
-
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:
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)
-
-
Parameters:
-
path - the path -
resource - the 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)
- 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:
WorkspaceAction
- Returns the operation to perform when this action runs. The returned
operation must be an
IRunnableWithProgress 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.
-
-
Overrides:
-
createOperation
in class
WorkspaceAction
-
-
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.
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
|
|
|
