Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.ui.actions
Class BuildAction

    java.lang.Object
      org.eclipse.jface.action.Action
          org.eclipse.ui.actions.BaseSelectionListenerAction
              org.eclipse.ui.actions.SelectionListenerAction
                  org.eclipse.ui.actions.WorkspaceAction
                      org.eclipse.ui.actions.BuildAction

All Implemented Interfaces:
  IAction, ISelectionChangedListener

public class BuildAction
extends WorkspaceAction

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, 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.
`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` | `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`

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 org.eclipse.jface.action.Action
`addPropertyChangeListener, convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, firePropertyChange, firePropertyChange, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, notifyResult, removeAcceleratorText, removeMnemonics, removePropertyChangeListener, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### ID_BUILD

    public static final String ID_BUILD

  The id of an incremental build action.

  See Also:
    Constant Field Values

### ID_REBUILD_ALL

    public static final String ID_REBUILD_ALL

  The id of a rebuild all action.

  See Also:
    Constant Field Values

Constructor Detail

### BuildAction

    public BuildAction(Shell shell,
                       int type)

  Creates a new action of the appropriate type. The action id is `ID_BUILD` for incremental builds and `ID_REBUILD_ALL` for full builds.

Parameters:
  `shell` - the shell for any dialogs
  `type` - the type of build; one of `IncrementalProjectBuilder.INCREMENTAL_BUILD` or `IncrementalProjectBuilder.FULL_BUILD`

Method Detail

### getActionResources

    protected List getActionResources()

  Description copied from class: `WorkspaceAction`
  Returns the elements that the action is to be performed on. By default return the selected resources.

  Overrides:
    `getActionResources` in class `WorkspaceAction`
  Returns:
    list of resource elements (element type: `IResource`)

### 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:
    `true` if Save All Before Build is enabled

### run

    public void run()

  Description copied from class: `WorkspaceAction`
  The `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.

  Specified by:
    `run` in interface `IAction`
  Overrides:
    `run` in class `WorkspaceAction`

### updateSelection

    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.

  Overrides:
    `updateSelection` in class `WorkspaceAction`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
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, 2004. All rights reserved.