Package org.eclipse.ui.dialogs
Class WorkingSetConfigurationBlock
- java.lang.Object
-
- org.eclipse.ui.dialogs.WorkingSetConfigurationBlock
-
public class WorkingSetConfigurationBlock extends Object
Instances of this class provide a reusable composite with controls that allow the selection of working sets. This class is most useful inIWizardPage
instances that wish to create resources and pre-install them into particular working sets.- Since:
- 3.4
-
-
Constructor Summary
Constructors Constructor Description WorkingSetConfigurationBlock(String[] workingSetIds, IDialogSettings settings)
Create a new instance of this working set block using default labels.WorkingSetConfigurationBlock(String[] workingSetIds, IDialogSettings settings, String enableButtonLabel, String comboLabel, String selectLabel)
Create a new instance of this working set block using custom labels.WorkingSetConfigurationBlock(IDialogSettings settings, String... workingSetIds)
Create a new instance of this working set block using default labels.WorkingSetConfigurationBlock(IDialogSettings settings, String enableButtonLabel, String newButtonLabel, String comboLabel, String selectLabel, String... workingSetIds)
Create a new instance of this working set block using custom labels.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
createContent(Composite parent)
Add this block to theparent
static IWorkingSet[]
filter(IWorkingSet[] workingSets, String[] workingSetIds)
Filters the given working sets such that the following is true: for each IWorkingSet s in result: s.getId() is element of workingSetIdsIWorkingSet[]
findApplicableWorkingSets(IStructuredSelection selection)
Retrieves a working set from the givenselection
or an empty array if no working set could be retrieved.IWorkingSet[]
getSelectedWorkingSets()
Return the currently selected working sets.void
setSelection(IStructuredSelection selection)
Deprecated.void
setWorkingSets(IWorkingSet... workingSets)
Set the current selection of working sets.
-
-
-
Constructor Detail
-
WorkingSetConfigurationBlock
public WorkingSetConfigurationBlock(IDialogSettings settings, String... workingSetIds)
Create a new instance of this working set block using default labels.- Parameters:
settings
- to store/load the selection historyworkingSetIds
- working set ids from which the user can choose- Since:
- 3.108
-
WorkingSetConfigurationBlock
public WorkingSetConfigurationBlock(String[] workingSetIds, IDialogSettings settings)
Create a new instance of this working set block using default labels.Note: Consider using the vararg version of this contructor.
- Parameters:
workingSetIds
- working set ids from which the user can choosesettings
- to store/load the selection history
-
WorkingSetConfigurationBlock
public WorkingSetConfigurationBlock(String[] workingSetIds, IDialogSettings settings, String enableButtonLabel, String comboLabel, String selectLabel)
Create a new instance of this working set block using custom labels.Note: Consider using the vararg version of this contructor.
- Parameters:
workingSetIds
- working set ids from which the user can choosesettings
- to store/load the selection historyenableButtonLabel
- the label to use for the checkable enablement button. May benull
to use the default value.comboLabel
- the label to use for the recent working set combo. May benull
to use the default value.selectLabel
- the label to use for the select button. May benull
to use the default value.
-
WorkingSetConfigurationBlock
public WorkingSetConfigurationBlock(IDialogSettings settings, String enableButtonLabel, String newButtonLabel, String comboLabel, String selectLabel, String... workingSetIds)
Create a new instance of this working set block using custom labels.- Parameters:
settings
- to store/load the selection historyenableButtonLabel
- the label to use for the checkable enablement button. May benull
to use the default value.newButtonLabel
- the label to use for the new button. May benull
to use the default value.comboLabel
- the label to use for the recent working set combo. May benull
to use the default value.selectLabel
- the label to use for the select button. May benull
to use the default value.workingSetIds
- working set ids from which the user can choose- Since:
- 3.108
-
-
Method Detail
-
filter
public static IWorkingSet[] filter(IWorkingSet[] workingSets, String[] workingSetIds)
Filters the given working sets such that the following is true: for each IWorkingSet s in result: s.getId() is element of workingSetIds- Parameters:
workingSets
- the array to filterworkingSetIds
- the acceptable working set ids- Returns:
- the filtered elements
-
setSelection
@Deprecated public void setSelection(IStructuredSelection selection)
Deprecated.Set the current selection in the workbench.- Parameters:
selection
- the selection to present in the UI or null
-
setWorkingSets
public void setWorkingSets(IWorkingSet... workingSets)
Set the current selection of working sets. This array will be filtered to contain only working sets that are applicable to this instance.- Parameters:
workingSets
- the working sets
-
findApplicableWorkingSets
public IWorkingSet[] findApplicableWorkingSets(IStructuredSelection selection)
Retrieves a working set from the givenselection
or an empty array if no working set could be retrieved. This selection is filtered based on the criteria used to construct this instance.- Parameters:
selection
- the selection to retrieve the working set from- Returns:
- the selected working set or an empty array
-
getSelectedWorkingSets
public IWorkingSet[] getSelectedWorkingSets()
Return the currently selected working sets. If the controls representing this block are disabled this array will be empty regardless of the currently selected values.- Returns:
- the selected working sets
-
createContent
public void createContent(Composite parent)
Add this block to theparent
- Parameters:
parent
- the parent to add the block to
-
-