Package org.eclipse.ui.actions

Class RenameResourceAction

    • Constructor Detail

      • RenameResourceAction

        @Deprecated
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​(IShellProvider provider,
                            Tree tree)
        Creates a new action.
        Parameters:
        provider - the shell provider for any dialogs
        tree - the tree
        Since:
        3.4

    • Method Detail

      • getActionResources

        protected List<? extends IResource> 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
        See Also:
        How radio buttons are handled, How check boxes are handled

      • 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