public interface IWorkingSet extends IPersistableElement, IAdaptable
This interface is not intended to be implemented by clients.
IPersistableElement, 3.2 now extends IAdaptable| Modifier and Type | Method and Description |
|---|---|
IAdaptable[] |
getElements()
Returns the elements that are contained in this working set.
|
String |
getId()
Returns the working set id.
|
ImageDescriptor |
getImage()
Returns the working set icon.
|
String |
getLabel()
Return the name of this working set, formated for the end user.
|
String |
getName()
Returns the name of the working set.
|
boolean |
isAggregateWorkingSet()
Returns whether this working set is an aggregate working set or not.
|
boolean |
isEditable()
Returns whether this working set can be edited or not.
|
boolean |
isEmpty()
Returns whether this working set is currently empty (has no elements).
|
boolean |
isSelfUpdating()
Returns
true if this working set is capable of updating
itself and reacting to changes in the state of its members. |
boolean |
isVisible()
Returns whether this working set should be shown in user interface
components that list working sets by name.
|
void |
setElements(IAdaptable[] elements)
Sets the elements that are contained in this working set.
|
void |
setId(String id)
Sets the working set id.
|
void |
setLabel(String label)
Set the name of this working set, formated for the end user.
|
void |
setName(String name)
Sets the name of the working set.
|
getFactoryIdsaveStategetAdapterIAdaptable[] getElements()
String getId()
null if no
working set id has been set.
This is one of the ids defined by extensions of the
org.eclipse.ui.workingSets extension point.
It is used by the workbench to determine the page to use in
the working set edit wizard. The default resource edit page
is used if this value is null.nullImageDescriptor getImage()
getId().
Returns null if no icon has been specified in the
extension or if getId() returns null.null.String getName()
void setElements(IAdaptable[] elements)
elements - the elements to set in this working setvoid setId(String id)
null.id - the working set id. May be nullvoid setName(String name)
name - the name of the working setboolean isEditable()
pageClass of
the extension defining a working set must be provided.true if the working set can be edited; otherwise
falseboolean isVisible()
true if the working set should be shown in the
user interface; otherwise falseString getLabel()
getName().void setLabel(String label)
label - the label for this working set. If null is
supplied then the value of getName() will be used.boolean isSelfUpdating()
true if this working set is capable of updating
itself and reacting to changes in the state of its members. For
non-aggregate working sets this means that the working set has an
IWorkingSetUpdater installed while for aggregates it means that
all component sets have IWorkingSetUpdaters installed. Otherwise
returns false.boolean isAggregateWorkingSet()
It is recommended that clients of aggregate working sets treat them in a
specific way. Please see the documentation for
IWorkbenchPage.getAggregateWorkingSet() for details.
boolean isEmpty()
Guidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.