Eclipse Plug-in Developer Guide (Galileo) - DeleteResourceAction (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.actions
Class DeleteResourceAction


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.DeleteResourceAction

All Implemented Interfaces:: IAction, ISelectionChangedListener

public class DeleteResourceAction
extends SelectionListenerAction
extends SelectionListenerAction

Standard action for deleting the currently 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

protected boolean fTestingMode
          Flag that allows testing mode ... it won't pop up the project delete dialog, and will return "delete all content".

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

DeleteResourceAction ( IShellProvider provider)
          Creates a new delete resource action.

DeleteResourceAction ( Shell shell)
          Deprecated. Should take an IShellProvider, see DeleteResourceAction(IShellProvider)

Method Summary

String[] getModelProviderIds ()
          Returns the model provider ids that are known to the client that instantiated this operation.

void run ()
          The default implementation of this IAction method does nothing.

void setModelProviderIds ( String[] modelProviderIds)
          Sets the model provider ids that are known to the client that instantiated this operation.

protected boolean updateSelection ( IStructuredSelection selection)
          The DeleteResourceAction implementation of this SelectionListenerAction method disables the action if the selection contains phantom resources or non-resources

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

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

ID

public static final 
String ID

The id of this action.

See Also:: Constant Field Values

fTestingMode

protected boolean fTestingMode

Flag that allows testing mode ... it won't pop up the project delete dialog, and will return "delete all content".

Constructor Detail

DeleteResourceAction

public DeleteResourceAction(
Shell shell)

Deprecated. Should take an IShellProvider, see DeleteResourceAction(IShellProvider)

Creates a new delete resource action.

Parameters:: shell - the shell for any dialogs

DeleteResourceAction

public DeleteResourceAction(
IShellProvider provider)

Creates a new delete resource action.

Parameters:: provider - the shell provider to use. Must not be null.
Since:: 3.4

Method Detail

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.

Specified by:: run in interface IAction
Overrides:: run in class Action

updateSelection

protected boolean updateSelection(
IStructuredSelection selection)

The DeleteResourceAction implementation of this SelectionListenerAction method disables the action if the selection contains phantom resources or non-resources

Overrides:: updateSelection in class BaseSelectionListenerAction

Parameters:: selection - the new selection
Returns:: true if the action should be enabled for this selection, and false otherwise

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.