Package org.eclipse.ui.actions
Class CopyResourceAction
-
- All Implemented Interfaces:
IAction,ISelectionChangedListener,ISelectionValidator
- Direct Known Subclasses:
MoveResourceAction
public class CopyResourceAction extends SelectionListenerAction implements ISelectionValidator
Standard action for copying the currently selected resources elsewhere in the workspace. All resources being copied as a group must be siblings.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.protected CopyFilesAndFoldersOperationoperationThe operation to run.protected IShellProvidershellProviderThe IShellProvider in which to show any dialogs.-
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 CopyResourceAction(IShellProvider provider)Creates a new actionCopyResourceAction(Shell shell)Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected CopyFilesAndFoldersOperationcreateOperation()Returns the operation to perform when this action runs.String[]getModelProviderIds()Returns the model provider ids that are known to the client that instantiated this operation.static IPathgetNewNameFor(IPath originalName, IWorkspace workspace)Returns a new name for a copy of the resource at the given path in the given workspace.protected IResource[]getResources(List<? extends IResource> resourceList)Returns an array of resources to use for the operation from the provided list.StringisValid(Object destination)TheCopyResourceActionimplementation of thisISelectionValidatormethod checks whether the given path is a good place to copy the selected resources.voidrun()The default implementation of thisIActionmethod does nothing.protected voidrunOperation(IResource[] resources, IContainer destination)Runs the operation created increateOperationvoidsetModelProviderIds(String[] modelProviderIds)Sets the model provider ids that are known to the client that instantiated this operation.protected booleanupdateSelection(IStructuredSelection selection)TheCopyResourceActionimplementation of thisSelectionListenerActionmethod enables this action only if all of the one or more selections are sibling resources which are local (depth infinity).-
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
-
shellProvider
protected IShellProvider shellProvider
The IShellProvider in which to show any dialogs.
-
operation
protected CopyFilesAndFoldersOperation operation
The operation to run. This is created only during the life-cycle of the run method.
-
-
Constructor Detail
-
CopyResourceAction
@Deprecated public CopyResourceAction(Shell shell)
Deprecated.Creates a new action.- Parameters:
shell- the shell for any dialogs
-
CopyResourceAction
public CopyResourceAction(IShellProvider provider)
Creates a new action- Parameters:
provider- the shell for any dialogs- Since:
- 3.4
-
-
Method Detail
-
getNewNameFor
public static IPath getNewNameFor(IPath originalName, IWorkspace workspace)
Returns a new name for a copy of the resource at the given path in the given workspace. This name could be determined either automatically or by querying the user. This name will not be verified by the caller, so it must be valid and unique.Note this method is for internal use only.
- Parameters:
originalName- the full path of the resourceworkspace- the workspace- Returns:
- the new full path for the copy, or
nullif the resource should not be copied
-
createOperation
protected CopyFilesAndFoldersOperation createOperation()
Returns the operation to perform when this action runs.- Returns:
- the operation to perform when this action runs.
-
getResources
protected IResource[] getResources(List<? extends IResource> resourceList)
Returns an array of resources to use for the operation from the provided list.- Parameters:
resourceList- The list of resources to converted into an array.- Returns:
- an array of resources to use for the operation
-
isValid
public String isValid(Object destination)
TheCopyResourceActionimplementation of thisISelectionValidatormethod checks whether the given path is a good place to copy the selected resources.- Specified by:
isValidin interfaceISelectionValidator- Parameters:
destination- the selection to be validated- Returns:
- the error message, or
nullindicating that the value is valid
-
run
public void run()
Description copied from class:ActionThe default implementation of thisIActionmethod does nothing. Subclasses should override this method if they do not need information from the triggering event, or overriderunWithEvent(Event)if they do.- Specified by:
runin interfaceIAction- Overrides:
runin classAction- See Also:
How radio buttons are handled,How check boxes are handled
-
runOperation
protected void runOperation(IResource[] resources, IContainer destination)
Runs the operation created increateOperation- Parameters:
resources- source resources to pass to the operationdestination- destination container to pass to the operation
-
updateSelection
protected boolean updateSelection(IStructuredSelection selection)
TheCopyResourceActionimplementation of thisSelectionListenerActionmethod enables this action only if all of the one or more selections are sibling resources which are local (depth infinity).- Overrides:
updateSelectionin classBaseSelectionListenerAction- Parameters:
selection- the new selection- Returns:
trueif the action should be enabled for this selection, andfalseotherwise
-
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
-
-