|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A working set manager stores working sets and provides property change notification when a working set is added or removed.
The workbench working set manager can be accessed using
IWorkbench#getWorkingSetManager()
This interface is not intended to be implemented by clients.
IWorkingSet
Field Summary | |
---|---|
static String |
CHANGE_WORKING_SET_ADD
Change event id when a working set is added newValue of the PropertyChangeEvent will be the added working set. |
static String |
CHANGE_WORKING_SET_CONTENT_CHANGE
Change event id when the working set contents changed newValue of the PropertyChangeEvent will be the changed working set. |
static String |
CHANGE_WORKING_SET_NAME_CHANGE
Change event id when the working set name changed. |
static String |
CHANGE_WORKING_SET_REMOVE
Change event id when a working set is removed newValue of the PropertyChangeEvent will be null. |
static String |
CHANGE_WORKING_SET_UPDATER_INSTALLED
Change event id when a working set updater got installed. |
Method Summary | |
---|---|
void |
addPropertyChangeListener(IPropertyChangeListener listener)
Adds a property change listener. |
void |
addRecentWorkingSet(IWorkingSet workingSet)
Adds a working set to the top of the list of most recently used working sets, making it the most recently used working set. |
void |
addWorkingSet(IWorkingSet workingSet)
Adds a working set to the receiver. |
IWorkingSet |
createWorkingSet(IMemento memento)
Re-creates and returns a working set from the state captured within the given memento. |
IWorkingSet |
createWorkingSet(String name,
IAdaptable[] elements)
Creates a new working set. |
IWorkingSetEditWizard |
createWorkingSetEditWizard(IWorkingSet workingSet)
Creates a working set edit wizard for the specified working set. |
IWorkingSetNewWizard |
createWorkingSetNewWizard(String[] workingSetIds)
Creates a working set new wizard. |
IWorkingSetSelectionDialog |
createWorkingSetSelectionDialog(Shell parent)
Deprecated. use createWorkingSetSelectionDialog(parent, true) instead |
IWorkingSetSelectionDialog |
createWorkingSetSelectionDialog(Shell parentShell,
boolean multi)
Creates a working set selection dialog that lists all working sets and allows the user to add, remove and edit working sets. |
IWorkingSetSelectionDialog |
createWorkingSetSelectionDialog(Shell parentShell,
boolean multi,
String[] workingsSetIds)
Creates a working set selection dialog that lists all working sets with the specified ids and allows the user to add, remove and edit working sets with the specified ids. |
void |
dispose()
Disposes the working set manager. |
IWorkingSet[] |
getRecentWorkingSets()
Returns the list of most recently used working sets. |
IWorkingSet |
getWorkingSet(String name)
Returns the working set with the specified name. |
IWorkingSet[] |
getWorkingSets()
Returns an array of all working sets stored in the receiver. |
void |
removePropertyChangeListener(IPropertyChangeListener listener)
Removes the property change listener. |
void |
removeWorkingSet(IWorkingSet workingSet)
Removes the working set |
Field Detail |
public static final String CHANGE_WORKING_SET_ADD
IPropertyChangeListener
,
Constant Field Valuespublic static final String CHANGE_WORKING_SET_REMOVE
IPropertyChangeListener
,
Constant Field Valuespublic static final String CHANGE_WORKING_SET_CONTENT_CHANGE
IPropertyChangeListener
,
Constant Field Valuespublic static final String CHANGE_WORKING_SET_NAME_CHANGE
IPropertyChangeListener
,
Constant Field Valuespublic static final String CHANGE_WORKING_SET_UPDATER_INSTALLED
null
Method Detail |
public void addPropertyChangeListener(IPropertyChangeListener listener)
listener
- the property change listener to addpublic void addRecentWorkingSet(IWorkingSet workingSet)
workingSet
- the working set to add to the list of most
recently used working sets.public void addWorkingSet(IWorkingSet workingSet)
workingSet
- the working set to addpublic IWorkingSet createWorkingSet(String name, IAdaptable[] elements)
name
- the name of the new working set. Should not have
leading or trailing whitespace.elements
- the working set contents
public IWorkingSet createWorkingSet(IMemento memento)
memento
- a memento containing the state for the working set
null
if it could not be createdpublic IWorkingSetEditWizard createWorkingSetEditWizard(IWorkingSet workingSet)
IWorkingSetEditWizard wizard = workingSetManager.createWorkingSetEditWizard(workingSet);
if (wizard != null) {
WizardDialog dialog = new WizardDialog(shell, wizard);
dialog.create();
if (dialog.open() == Window.OK) {
workingSet = wizard.getSelection();
}
}
workingSet
- working set to create a working set edit wizard
for.
null
if no edit wizard has been defined for the
working set. If the defined edit wizard for the working set could
not be loaded a default IResource based wizard will be returned.
If the default edit wizard can not be loaded null
is
returned.public IWorkingSetNewWizard createWorkingSetNewWizard(String[] workingSetIds)
null
if there aren't any working set
definitions that support creation of working sets.
Example:
IWorkingSetNewWizard wizard= workingSetManager.createWorkingSetNewWizard(null);
if (wizard != null) {
WizardDialog dialog = new WizardDialog(shell, wizard);
dialog.create();
if (dialog.open() == Window.OK) {
...
}
}
workingSetIds
- a list of working set ids which are valid workings sets
to be created or null
if all currently available working set types
are valid
null
public IWorkingSetSelectionDialog createWorkingSetSelectionDialog(Shell parent)
parent
- the parent shell
public IWorkingSetSelectionDialog createWorkingSetSelectionDialog(Shell parentShell, boolean multi)
IWorkingSetSelectionDialog#open
, and subsequently
extracting the selected working sets using
IWorkingSetSelectionDialog#getSelection
.
parentShell
- the parent shell of the working set selection dialogmulti
- true=more than one working set can be chosen
in the dialog. false=only one working set can be chosen. Multiple
working sets can still be selected and removed from the list but
the dialog can only be closed when a single working set is selected.
public IWorkingSetSelectionDialog createWorkingSetSelectionDialog(Shell parentShell, boolean multi, String[] workingsSetIds)
IWorkingSetSelectionDialog#open
, and subsequently
extracting the selected working sets using
IWorkingSetSelectionDialog#getSelection
.
parentShell
- the parent shell of the working set selection dialogmulti
- true=more than one working set can be chosen
in the dialog. false=only one working set can be chosen. Multiple
working sets can still be selected and removed from the list but
the dialog can only be closed when a single working set is selected.workingsSetIds
- a list of working set ids which are valid workings sets
to be selected, created, removed or edited, or null
if all currently
available working set types are valid
public IWorkingSet[] getRecentWorkingSets()
public IWorkingSet getWorkingSet(String name)
name
- the name of the working set to return
public IWorkingSet[] getWorkingSets()
public void removePropertyChangeListener(IPropertyChangeListener listener)
listener
- the property change listener to removepublic void removeWorkingSet(IWorkingSet workingSet)
workingSet
- the working set to removepublic void dispose()
|
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.