Eclipse Platform
2.1

org.eclipse.ui.actions
Class CopyResourceAction

java.lang.Object
  |
  +--org.eclipse.jface.action.Action
        |
        +--org.eclipse.ui.actions.SelectionListenerAction
              |
              +--org.eclipse.ui.actions.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.


Field Summary
static String ID
          The id of this action.
protected  CopyFilesAndFoldersOperation operation
           
 
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, IMAGE, TEXT, TOOL_TIP_TEXT
 
Constructor Summary
CopyResourceAction(Shell shell)
          Creates a new action.
 
Method Summary
protected  CopyFilesAndFoldersOperation createOperation()
          Returns the operation to perform when this action runs.
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.
protected  IResource[] getResources(List resourceList)
          Returns an array of resources to use for the operation from the provided list.
 String isValid(Object destination)
          The CopyResourceAction implementation of this ISelectionValidator method checks whether the given path is a good place to copy the selected resources.
 void run()
          The default implementation of this IAction method does nothing.
protected  void runOperation(IResource[] resources, IContainer destination)
          Runs the operation created in createOperaiton
protected  boolean updateSelection(IStructuredSelection selection)
          The CopyResourceAction implementation of this SelectionListenerAction method 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
getSelectedNonResources, getSelectedResources, getStructuredSelection, resourceIsType, selectionChanged, selectionChanged, selectionIsOfType
 
Methods inherited from class org.eclipse.jface.action.Action
addPropertyChangeListener, convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, firePropertyChange, firePropertyChange, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, removeAcceleratorText, removePropertyChangeListener, runWithEvent, 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
 

Field Detail

ID

public static final String ID
The id of this action.

operation

protected CopyFilesAndFoldersOperation operation
Constructor Detail

CopyResourceAction

public CopyResourceAction(Shell shell)
Creates a new action.
Parameters:
shell - the shell for any dialogs
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 resource
workspace - the workspace
Returns:
the new full path for the copy, or null if 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 resourceList)
Returns an array of resources to use for the operation from the provided list.
Returns:
an array of resources to use for the operation

isValid

public String isValid(Object destination)
The CopyResourceAction implementation of this ISelectionValidator method checks whether the given path is a good place to copy the selected resources.
Specified by:
isValid in interface ISelectionValidator
Following copied from interface: org.eclipse.ui.dialogs.ISelectionValidator
Parameters:
selection - the selection to be validated
Returns:
the error message, or null indicating that the value is valid

run

public void run()
Description copied from class: Action
The default implementation of this IAction method does nothing. Subclasses should override this method if they do not need information from the triggering event, or override runWithEvent(Event) if they do.
Overrides:
run in class Action

runOperation

protected void runOperation(IResource[] resources,
                            IContainer destination)
Runs the operation created in createOperaiton
Parameters:
resources - source resources to pass to the operation
destination - destination container to pass to the operation

updateSelection

protected boolean updateSelection(IStructuredSelection selection)
The CopyResourceAction implementation of this SelectionListenerAction method enables this action only if all of the one or more selections are sibling resources which are local (depth infinity).
Overrides:
updateSelection in class SelectionListenerAction
Following copied from class: org.eclipse.ui.actions.SelectionListenerAction
Parameters:
selection - the new selection
Returns:
true if the action should be enabled for this selection, and false otherwise

Eclipse Platform
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.