public class BuildAction extends WorkspaceAction
This class may be instantiated; it is not intended to be subclassed.
Modifier and Type | Field and Description |
---|---|
static String |
ID_BUILD
The id of an incremental build action.
|
static String |
ID_REBUILD_ALL
The id of a rebuild all 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
Constructor and Description |
---|
BuildAction(IShellProvider provider,
int type)
Creates a new action of the appropriate type.
|
BuildAction(Shell shell,
int type)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
protected List |
getActionResources()
Returns the elements that the action is to be performed on.
|
protected List |
getBuildConfigurationsToBuild()
This collection of project build configs, derived from the selected
resources, is passed to the workspace for building.
|
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.
|
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. |
void |
runInBackground(ISchedulingRule rule,
Object[] jobFamilies)
Run the action in the background rather than with the progress dialog.
|
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. |
createOperation, invokeOperation, runInBackground, runInBackground
clearCache, getSelectedNonResources, getSelectedResources, 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, 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_BUILD
public static final String ID_REBUILD_ALL
public BuildAction(Shell shell, int type)
BuildAction(IShellProvider, int)
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
public BuildAction(IShellProvider provider, int type)
ID_BUILD
for incremental builds and
ID_REBUILD_ALL
for full builds.provider
- the shell provider for any dialogstype
- the type of build; one of
IncrementalProjectBuilder.INCREMENTAL_BUILD
or
IncrementalProjectBuilder.FULL_BUILD
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 List getBuildConfigurationsToBuild()
public 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
true
if enabled, and
false
if disabledIAction.ENABLED
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
How radio buttons are handled
,
How check boxes are handled
public void runInBackground(ISchedulingRule rule, Object[] jobFamilies)
WorkspaceAction
runInBackground
in class WorkspaceAction
rule
- The rule to apply to the background job or null
if there isn't one.jobFamilies
- the families the job should belong to or null
if none.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
s
- the new selectiontrue
if the action should be enabled for this selection,
and false
otherwise
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.