|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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
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, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, 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 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 void |
invokeOperation(IResource resource,
IProgressMonitor monitor)
Performs this action's operation on each of the selected resources, reporting progress to, and fielding cancel requests from, the given progress monitor. |
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. |
Methods inherited from class org.eclipse.ui.actions.WorkspaceAction |
---|
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.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 |
Field Detail |
public static final String ID
Constructor Detail |
public RenameResourceAction(Shell shell)
shell
- the shell for any dialogspublic RenameResourceAction(Shell shell, Tree tree)
shell
- the shell for any dialogstree
- the treeMethod Detail |
protected List getActionResources()
getActionResources
in class WorkspaceAction
IResource
)protected String getOperationMessage()
WorkspaceAction
Note that this hook method is invoked in a non-UI thread.
Subclasses must implement this method.
getOperationMessage
in class WorkspaceAction
protected 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 WorkspaceAction
protected 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 WorkspaceAction
protected void invokeOperation(IResource resource, IProgressMonitor monitor)
WorkspaceAction
Note that this method is invoked in a non-UI thread.
Subclasses must implement this method.
invokeOperation
in class WorkspaceAction
resource
- one of the selected resourcesmonitor
- a progress monitorprotected String queryNewResourceName(IResource resource)
resource
- the resource to query status on
public void run()
WorkspaceAction
CoreWrapperAction
implementation of this
IAction
method uses a ProgressMonitorDialog
to run the operation. The operation calls execute
(which,
in turn, calls invokeOperation
). Afterwards, any
CoreException
s encountered while running the operation
are reported to the user via a problems dialog.
Subclasses may extend this method.
run
in interface IAction
run
in class WorkspaceAction
protected 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 WorkspaceAction
public 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)
WorkspaceAction
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.
createOperation
in class WorkspaceAction
errorStatus
- an array of error status objects to which the result of
running the operation should be added.
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.