Class BuildAction
- All Implemented Interfaces:
IAction,ISelectionChangedListener
This class may be instantiated; it is not intended to be subclassed.
- Restriction:
- This class is not intended to be subclassed by clients.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe id of an incremental build action.static final StringThe 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
ConstructorsConstructorDescriptionBuildAction(IShellProvider provider, int type) Creates a new action of the appropriate type.BuildAction(Shell shell, int type) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionReturns the elements that the action is to be performed on.protected List<? extends IBuildConfiguration> This collection of project build configs, derived from the selected resources, is passed to the workspace for building.protected StringReturns the string to display for this action's operation.protected StringReturns the string to display for this action's problems dialog.protected StringReturns the title for this action's problems dialog.booleanReturns whether this action is enabled.static booleanReturns whether the user's preference is set to automatically save modified resources before a manual build is done.voidrun()TheCoreWrapperActionimplementation of thisIActionmethod uses aProgressMonitorDialogto run the operation.voidrunInBackground(ISchedulingRule rule, Object[] jobFamilies) Run the action in the background rather than with the progress dialog.protected booleanReturns whether this action should attempt to optimize the resources being operated on.protected booleanTheBuildActionimplementation of thisSelectionListenerActionmethod 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
createOperation, invokeOperation, runInBackground, runInBackgroundMethods inherited from class org.eclipse.ui.actions.SelectionListenerAction
clearCache, getSelectedNonResources, getSelectedResources, resourceIsType, selectionIsOfTypeMethods inherited from class org.eclipse.ui.actions.BaseSelectionListenerAction
getStructuredSelection, runWithEvent, selectionChanged, selectionChangedMethods 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, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipTextMethods inherited from class org.eclipse.jface.action.AbstractAction
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListenerMethods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
-
Field Details
-
ID_BUILD
The id of an incremental build action.- See Also:
-
ID_REBUILD_ALL
The id of a rebuild all action.- See Also:
-
-
Constructor Details
-
BuildAction
Deprecated.Creates a new action of the appropriate type. The action id isID_BUILDfor incremental builds andID_REBUILD_ALLfor full builds.- Parameters:
shell- the shell for any dialogstype- the type of build; one ofIncrementalProjectBuilder.INCREMENTAL_BUILDorIncrementalProjectBuilder.FULL_BUILD
-
BuildAction
Creates a new action of the appropriate type. The action id isID_BUILDfor incremental builds andID_REBUILD_ALLfor full builds.- Parameters:
provider- the shell provider for any dialogstype- the type of build; one ofIncrementalProjectBuilder.INCREMENTAL_BUILDorIncrementalProjectBuilder.FULL_BUILD- Since:
- 3.4
-
-
Method Details
-
getActionResources
Description copied from class:WorkspaceActionReturns the elements that the action is to be performed on. By default return the selected resources.Subclasses may override this method.
- Overrides:
getActionResourcesin classWorkspaceAction- Returns:
- list of resource elements (element type:
IResource)
-
getOperationMessage
Description copied from class:WorkspaceActionReturns the string to display for this action's operation.Note that this hook method is invoked in a non-UI thread.
Subclasses must implement this method.
- Specified by:
getOperationMessagein classWorkspaceAction- Returns:
- the message
-
getProblemsMessage
Description copied from class:WorkspaceActionReturns the string to display for this action's problems dialog.The
WorkspaceActionimplementation 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.- Overrides:
getProblemsMessagein classWorkspaceAction- Returns:
- the problems message
-
getProblemsTitle
Description copied from class:WorkspaceActionReturns the title for this action's problems dialog.The
WorkspaceActionimplementation of this method returns a generic title (localized counterpart of "Problems"). Subclasses may reimplement to provide something more suited to the particular action.- Overrides:
getProblemsTitlein classWorkspaceAction- Returns:
- the problems dialog title
-
getBuildConfigurationsToBuild
This collection of project build configs, derived from the selected resources, is passed to the workspace for building. The Workspace is responsible for resolving references.- Returns:
- List of project build configurations to build.
- Since:
- 3.7
-
isEnabled
public boolean isEnabled()Description copied from interface:IActionReturns whether this action is enabled.This method is associated with the
ENABLEDproperty; property change events are reported when its value changes. -
isSaveAllSet
public static boolean isSaveAllSet()Returns whether the user's preference is set to automatically save modified resources before a manual build is done.- Returns:
trueif Save All Before Build is enabled
-
run
public void run()Description copied from class:WorkspaceActionTheCoreWrapperActionimplementation of thisIActionmethod uses aProgressMonitorDialogto run the operation. The operation callsexecute(which, in turn, callsinvokeOperation). Afterwards, anyCoreExceptions encountered while running the operation are reported to the user via a problems dialog.Subclasses may extend this method.
- Specified by:
runin interfaceIAction- Overrides:
runin classWorkspaceAction- See Also:
-
runInBackground
Description copied from class:WorkspaceActionRun the action in the background rather than with the progress dialog.- Overrides:
runInBackgroundin classWorkspaceAction- Parameters:
rule- The rule to apply to the background job ornullif there isn't one.jobFamilies- the families the job should belong to ornullif none.
-
shouldPerformResourcePruning
protected boolean shouldPerformResourcePruning()Description copied from class:WorkspaceActionReturns whether this action should attempt to optimize the resources being operated on. This kind of pruning makes sense when the operation has depth infinity semantics (when the operation is applied explicitly to a resource then it is also applied implicitly to all the resource's descendents).The
WorkspaceActionimplementation of this method returnstrue. Subclasses should reimplement to returnfalseif pruning is not required.- Overrides:
shouldPerformResourcePruningin classWorkspaceAction- Returns:
trueif pruning should be performed, andfalseif pruning is not desired
-
updateSelection
TheBuildActionimplementation of thisSelectionListenerActionmethod ensures that this action is enabled only if all of the selected resources have buildable projects.- Overrides:
updateSelectionin classWorkspaceAction- Parameters:
s- the new selection- Returns:
trueif the action should be enabled for this selection, andfalseotherwise
-
BuildAction(IShellProvider, int)