|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.action.Action
org.eclipse.ui.actions.BaseSelectionListenerAction
org.eclipse.ui.actions.SelectionListenerAction
org.eclipse.ui.actions.WorkspaceAction
org.eclipse.ui.actions.BuildAction
Standard actions for full and incremental builds of the selected project(s).
This class may be instantiated; it is not intended to be subclassed.
Field Summary | |
---|---|
static String |
ID_BUILD
The id of an incremental build action. |
static String |
ID_REBUILD_ALL
The id of a rebuild all 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 | |
---|---|
BuildAction(Shell shell,
int type)
Creates a new action of the appropriate type. |
Method Summary | |
---|---|
protected List |
getActionResources()
Returns the elements that the action is to be performed on. |
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 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. |
boolean |
isEnabled()
Returns whether this action is enabled. |
static boolean |
isSaveAllSet()
Returns whether the user's preference is set to automatically save modified resources before a manual build is done. |
void |
run()
The CoreWrapperAction implementation of this IAction
method uses a ProgressMonitorDialog to run the operation. |
protected boolean |
shouldPerformResourcePruning()
Returns whether this action should attempt to optimize the resources being operated on. |
protected boolean |
updateSelection(IStructuredSelection s)
The BuildAction implementation of this
SelectionListenerAction method ensures that this action is
enabled only if all of the selected resources have buildable projects. |
Methods inherited from class org.eclipse.ui.actions.WorkspaceAction |
---|
runInBackground, runInBackground, runInBackground |
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String ID_BUILD
public static final String ID_REBUILD_ALL
Constructor Detail |
public BuildAction(Shell shell, int type)
ID_BUILD
for incremental builds and ID_REBUILD_ALL
for full builds.
shell
- the shell for any dialogstype
- the type of build; one of
IncrementalProjectBuilder.INCREMENTAL_BUILD
or
IncrementalProjectBuilder.FULL_BUILD
Method Detail |
protected List getActionResources()
WorkspaceAction
Subclasses may override this method.
getActionResources
in class WorkspaceAction
IResource
)protected 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 monitor
CoreException
- if the operation failspublic boolean isEnabled()
IAction
This method is associated with the ENABLED
property;
property change events are reported when its value changes.
isEnabled
in interface IAction
isEnabled
in class Action
public static boolean isSaveAllSet()
true
if Save All Before Build is enabledpublic void run()
WorkspaceAction
CoreWrapperAction
implementation of this IAction
method uses a ProgressMonitorDialog
to run the operation. The
operation calls execute
(which, in turn, calls
invokeOperation
). Afterwards, any CoreException
s
encountered while running the operation are reported to the user via a
problems dialog.
Subclasses may extend this method.
run
in interface IAction
run
in class WorkspaceAction
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)
BuildAction
implementation of this
SelectionListenerAction
method ensures that this action is
enabled only if all of the selected resources have buildable projects.
updateSelection
in class WorkspaceAction
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.