Package org.eclipse.gef.ui.actions
Class SelectionAction
- java.lang.Object
-
- org.eclipse.core.commands.common.EventManager
-
- org.eclipse.jface.action.AbstractAction
-
- org.eclipse.jface.action.Action
-
- org.eclipse.gef.ui.actions.WorkbenchPartAction
-
- org.eclipse.gef.ui.actions.SelectionAction
-
- All Implemented Interfaces:
Disposable,UpdateAction,IAction
- Direct Known Subclasses:
AlignmentAction,DeleteAction,DirectEditAction,MatchSizeAction,PasteTemplateAction
public abstract class SelectionAction extends WorkbenchPartAction
Superclass for an action needing the current selection.
-
-
Field Summary
-
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 SelectionAction(IWorkbenchPart part)Creates aSelectionActionand associates it with the given workbench part.SelectionAction(IWorkbenchPart part, int style)Creates aSelectionActionand associates it with the given editor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddispose()Disposes the action when it is no longer needed.protected java.util.ListgetSelectedObjects()Returns aListcontaining the currently selected objects.protected ISelectiongetSelection()Gets the current selection.protected voidhandleSelectionChanged()Called when the selection is changed.protected voidsetSelection(ISelection selection)Sets the current selection and calls on subclasses to handle the selectionChanged event.voidsetSelectionProvider(ISelectionProvider provider)May be used to provide an alternative selection source other than the workbench's selection service.voidupdate()Called to update the receiver.-
Methods inherited from class org.eclipse.gef.ui.actions.WorkbenchPartAction
calculateEnabled, execute, getCommandStack, getWorkbenchPart, init, isEnabled, refresh, setLazyEnablementCalculation, setWorkbenchPart
-
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, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, run, runWithEvent, 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
-
-
-
-
Constructor Detail
-
SelectionAction
public SelectionAction(IWorkbenchPart part, int style)
Creates aSelectionActionand associates it with the given editor.- Parameters:
part- The workbench part associated with this actionstyle- the style for this action
-
SelectionAction
public SelectionAction(IWorkbenchPart part)
Creates aSelectionActionand associates it with the given workbench part.- Parameters:
part- the workbench part
-
-
Method Detail
-
dispose
public void dispose()
Description copied from class:WorkbenchPartActionDisposes the action when it is no longer needed.- Specified by:
disposein interfaceDisposable- Overrides:
disposein classWorkbenchPartAction- See Also:
Disposable.dispose()
-
getSelectedObjects
protected java.util.List getSelectedObjects()
Returns aListcontaining the currently selected objects.- Returns:
- A List containing the currently selected objects.
-
getSelection
protected ISelection getSelection()
Gets the current selection.- Returns:
- The current selection.
-
handleSelectionChanged
protected void handleSelectionChanged()
Called when the selection is changed.
-
setSelection
protected void setSelection(ISelection selection)
Sets the current selection and calls on subclasses to handle the selectionChanged event.- Parameters:
selection- The new selection.
-
setSelectionProvider
public void setSelectionProvider(ISelectionProvider provider)
May be used to provide an alternative selection source other than the workbench's selection service. Use of this method is optional. The default value isnull, in which case the selection is obtained using the partsite's selection service.- Parameters:
provider-nullor a selection provider
-
update
public void update()
Description copied from interface:UpdateActionCalled to update the receiver.- Specified by:
updatein interfaceUpdateAction- Overrides:
updatein classWorkbenchPartAction- See Also:
WorkbenchPartAction.update()
-
-