|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IWorkingSet
A working set holds a number of IAdaptable elements. A working set is intended to group elements for presentation to the user or for operations on a set of elements.
This interface is not intended to be implemented by clients.
IPersistableElement
, 3.2 now extends IAdaptable
Method Summary | |
---|---|
IAdaptable[] |
getElements()
Returns the elements that are contained in this working set. |
java.lang.String |
getId()
Returns the working set id. |
ImageDescriptor |
getImage()
Returns the working set icon. |
java.lang.String |
getLabel()
Return the name of this working set, formated for the end user. |
java.lang.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(java.lang.String id)
Sets the working set id. |
void |
setLabel(java.lang.String label)
Set the name of this working set, formated for the end user. |
void |
setName(java.lang.String name)
Sets the name of the working set. |
Methods inherited from interface org.eclipse.ui.IPersistableElement |
---|
getFactoryId |
Methods inherited from interface org.eclipse.ui.IPersistable |
---|
saveState |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Method Detail |
---|
IAdaptable[] getElements()
java.lang.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
.
null
ImageDescriptor getImage()
getId()
.
Returns null
if no icon has been specified in the
extension or if getId()
returns null
.
null
.java.lang.String getName()
void setElements(IAdaptable[] elements)
elements
- the elements to set in this working setvoid setId(java.lang.String id)
null
.
id
- the working set id. May be null
void setName(java.lang.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
false
boolean isVisible()
true
if the working set should be shown in the
user interface; otherwise false
java.lang.String getLabel()
getName()
.
void setLabel(java.lang.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 IWorkingSetUpdater
s 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()
|
Eclipse Platform Release 3.2 |
|||||||||
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, 2006. All rights reserved.