public class CloseResourceAction extends WorkspaceAction implements IResourceChangeListener
This class may be instantiated; it is not intended to be subclassed.
Modifier and Type | Field and Description |
---|---|
static String |
ID
The id of this action.
|
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
Modifier | Constructor and Description |
---|---|
|
CloseResourceAction(IShellProvider provider)
Create the new action.
|
protected |
CloseResourceAction(IShellProvider provider,
String text)
Provide text to the action.
|
|
CloseResourceAction(Shell shell)
Deprecated.
|
protected |
CloseResourceAction(Shell shell,
String text)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
String[] |
getModelProviderIds()
Returns the model provider ids that are known to the client
that instantiated this operation.
|
protected String |
getOperationMessage()
Returns the string to display for this action's operation.
|
protected String |
getProblemsMessage()
Returns the string to display for this action's problems dialog.
|
protected String |
getProblemsTitle()
Returns the title for this action's problems dialog.
|
protected List<?> |
getSelectedNonResources()
Returns the elements in the current selection that are not
IResource s. |
protected List<? extends IResource> |
getSelectedResources()
Returns the elements in the current selection that are
IResource s. |
protected void |
invokeOperation(IResource resource,
IProgressMonitor monitor)
Performs this action's operation on each of the selected resources,
reporting progress to, and fielding cancel requests from, the given
progress monitor.
|
void |
resourceChanged(IResourceChangeEvent event)
Handles a resource changed event by updating the enablement
if one of the selected projects is opened or closed.
|
void |
run()
The implementation of this
WorkspaceAction method
method saves and closes the resource's dirty editors before closing
it. |
void |
setModelProviderIds(String[] modelProviderIds)
Sets the model provider ids that are known to the client
that instantiated this operation.
|
protected boolean |
shouldPerformResourcePruning()
Returns whether this action should attempt to optimize the resources
being operated on.
|
protected boolean |
updateSelection(IStructuredSelection s)
The
CloseResourceAction implementation of this
SelectionListenerAction method ensures that this action is
enabled only if one of the selections is an open project. |
createOperation, getActionResources, runInBackground, runInBackground, runInBackground
clearCache, resourceIsType, selectionIsOfType
getStructuredSelection, runWithEvent, selectionChanged, selectionChanged
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
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
public static final String ID
@Deprecated public CloseResourceAction(Shell shell)
CloseResourceAction(IShellProvider)
shell
- the shell for any dialogs@Deprecated protected CloseResourceAction(Shell shell, String text)
CloseResourceAction(IShellProvider, String)
public CloseResourceAction(IShellProvider provider)
provider
- the shell provider for any dialogsprotected CloseResourceAction(IShellProvider provider, String text)
provider
- the shell provider for any dialogstext
- labelprotected String getOperationMessage()
WorkspaceAction
Note that this hook method is invoked in a non-UI thread.
Subclasses must implement this method.
getOperationMessage
in class WorkspaceAction
protected String getProblemsMessage()
WorkspaceAction
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.
getProblemsMessage
in class WorkspaceAction
protected String getProblemsTitle()
WorkspaceAction
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.
getProblemsTitle
in class WorkspaceAction
protected void invokeOperation(IResource resource, IProgressMonitor monitor) throws CoreException
WorkspaceAction
Note that this method is invoked in a non-UI thread.
Subclasses must implement this method.
invokeOperation
in class WorkspaceAction
resource
- one of the selected resourcesmonitor
- a progress monitorCoreException
- if the operation failspublic void run()
WorkspaceAction
method
method saves and closes the resource's dirty editors before closing
it.run
in interface IAction
run
in class WorkspaceAction
How radio buttons are handled
,
How check boxes are handled
protected boolean shouldPerformResourcePruning()
WorkspaceAction
The WorkspaceAction
implementation of this method returns
true
. Subclasses should reimplement to return
false
if pruning is not required.
shouldPerformResourcePruning
in class WorkspaceAction
true
if pruning should be performed, and
false
if pruning is not desiredprotected boolean updateSelection(IStructuredSelection s)
CloseResourceAction
implementation of this
SelectionListenerAction
method ensures that this action is
enabled only if one of the selections is an open project.updateSelection
in class WorkspaceAction
s
- the new selectiontrue
if the action should be enabled for this selection,
and false
otherwisepublic void resourceChanged(IResourceChangeEvent event)
resourceChanged
in interface IResourceChangeListener
event
- the resource change eventIResourceDelta
protected List<? extends IResource> getSelectedResources()
SelectionListenerAction
IResource
s.getSelectedResources
in class SelectionListenerAction
IResource
)protected List<?> getSelectedNonResources()
SelectionListenerAction
IResource
s.getSelectedNonResources
in class SelectionListenerAction
Object
)public String[] getModelProviderIds()
public void setModelProviderIds(String[] modelProviderIds)
modelProviderIds
- the model providers known to the client
who is using this operation.
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.