|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.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.WorkspaceAction
org.eclipse.ui.actions.CloseResourceAction
public class CloseResourceAction
Standard action for closing the currently selected project(s).
This class may be instantiated; it is not intended to be subclassed.
| Field Summary | |
|---|---|
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 | |
|---|---|
|
CloseResourceAction(IShellProvider provider)
Create the new action. |
protected |
CloseResourceAction(IShellProvider provider,
String text)
Provide text to the action. |
|
CloseResourceAction(Shell shell)
Deprecated. See CloseResourceAction(IShellProvider) |
protected |
CloseResourceAction(Shell shell,
String text)
Deprecated. See CloseResourceAction(IShellProvider, String) |
| Method Summary | |
|---|---|
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 IResources. |
protected List |
getSelectedResources()
Returns the elements in the current selection that are IResources. |
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. |
| Methods inherited from class org.eclipse.ui.actions.WorkspaceAction |
|---|
createOperation, getActionResources, runInBackground, runInBackground, runInBackground |
| Methods inherited from class org.eclipse.ui.actions.SelectionListenerAction |
|---|
clearCache, resourceIsType, selectionIsOfType |
| Methods inherited from class org.eclipse.ui.actions.BaseSelectionListenerAction |
|---|
getStructuredSelection, runWithEvent, selectionChanged, selectionChanged |
| 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 |
|---|
public static final String ID
| Constructor Detail |
|---|
public CloseResourceAction(Shell shell)
CloseResourceAction(IShellProvider)
shell - the shell for any dialogs
protected CloseResourceAction(Shell shell,
String text)
CloseResourceAction(IShellProvider, String)
public CloseResourceAction(IShellProvider provider)
provider - the shell provider for any dialogs
protected CloseResourceAction(IShellProvider provider,
String text)
provider - the shell provider for any dialogstext - label| Method Detail |
|---|
protected String getOperationMessage()
WorkspaceActionNote that this hook method is invoked in a non-UI thread.
Subclasses must implement this method.
getOperationMessage in class WorkspaceActionprotected 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 WorkspaceActionprotected 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
WorkspaceActionNote that this method is invoked in a non-UI thread.
Subclasses must implement this method.
invokeOperation in class WorkspaceActionresource - one of the selected resourcesmonitor - a progress monitor
CoreException - if the operation failspublic void run()
WorkspaceAction method
method saves and closes the resource's dirty editors before closing
it.
run in interface IActionrun in class WorkspaceActionprotected 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 WorkspaceActiontrue 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 WorkspaceActions - the new selection
true if the action should be enabled for this selection,
and false otherwisepublic void resourceChanged(IResourceChangeEvent event)
resourceChanged in interface IResourceChangeListenerevent - the resource change eventIResourceDeltaprotected List getSelectedResources()
SelectionListenerActionIResources.
getSelectedResources in class SelectionListenerActionIResource)protected List getSelectedNonResources()
SelectionListenerActionIResources.
getSelectedNonResources in class SelectionListenerActionObject)public String[] getModelProviderIds()
public void setModelProviderIds(String[] modelProviderIds)
modelProviderIds - the model providers known to the client
who is using this operation.
|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.