org.eclipse.gef.ui.actions
Class DeleteAction

java.lang.Object
  |
  +--org.eclipse.jface.action.Action
        |
        +--org.eclipse.gef.ui.actions.EditorPartAction
              |
              +--org.eclipse.gef.ui.actions.SelectionAction
                    |
                    +--org.eclipse.gef.ui.actions.DeleteAction

All Implemented Interfaces:

Disposable, IAction, ISelectionListener

public final class DeleteAction

extends SelectionAction

An action to delete selected objects.

Field Summary

static String

ID

Fields inherited from class org.eclipse.gef.ui.actions.EditorPartAction

DYNAMIC, style

Fields inherited from interface org.eclipse.jface.action.IAction

AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, CHECKED, DESCRIPTION, ENABLED, IMAGE, TEXT, TOOL_TIP_TEXT

Constructor Summary

DeleteAction(IEditorPart editor)
Creates a DeleteAction with a default label.

DeleteAction(IEditorPart editor, int style)
Creates a DeleteAction with a default label.

DeleteAction(IEditorPart editor, int style, String label)
Creates a DeleteAction with the given label.

DeleteAction(IEditorPart editor, String label)
Creates a DeleteAction with the given label.

Method Summary

protected boolean	calculateEnabled() Returns true if the selected objects can be deleted.
static Command	createDeleteCommand(List objects) Create a command to remove the selected objects.
protected void	init() Initializes this action's text and images.
void	run() Performs the delete action on the selected objects.

Methods inherited from class org.eclipse.gef.ui.actions.SelectionAction

dispose, getSelectedObjects, getSelection, handleSelectionChanged, hookEditorPart, selectionChanged, setSelection, unhookEditorPart

Methods inherited from class org.eclipse.gef.ui.actions.EditorPartAction

checkStyle, execute, getCommandStack, getEditorPart, isDynamic, isEnabled, refresh, setEditorPart

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, 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

Constructor Detail

DeleteAction

public DeleteAction(IEditorPart editor,
                    int style)

Creates a DeleteAction with a default label.

Parameters:

editor - The editor this action will be associated with.

style - The style bitmask.

DeleteAction

public DeleteAction(IEditorPart editor)

Creates a DeleteAction with a default label.

Parameters:

editor - The editor this action will be associated with.

DeleteAction

public DeleteAction(IEditorPart editor,
                    int style,
                    String label)

Creates a DeleteAction with the given label.

Parameters:

editor - The editor this action will be associated with.

style - The style bitmask.

label - The label to be displayed for this action.

DeleteAction

public DeleteAction(IEditorPart editor,
                    String label)

Creates a DeleteAction with the given label.

Parameters:

editor - The editor this action will be associated with.

label - The label to be displayed for this action.

Method Detail

init

protected void init()

Initializes this action's text and images.

Overrides:

init in class EditorPartAction

createDeleteCommand

public static Command createDeleteCommand(List objects)

Create a command to remove the selected objects.

Parameters:

objects - The objects to be deleted.

Returns:

The command to remove the selected objects.

calculateEnabled

protected boolean calculateEnabled()

Returns true if the selected objects can be deleted. Returns false if there are no objects selected or the selected objects are not EditParts.

Overrides:

calculateEnabled in class EditorPartAction

run

public void run()

Performs the delete action on the selected objects.

Overrides:

run in class Action