Java Doc for IWorkingSet.java in » IDE-Eclipse » ui-workbench » org » eclipse » ui » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » IDE Eclipse » ui workbench » org.eclipse.ui

Source Cross Reference Class Diagram Java Document (Java Doc)

org.eclipse.ui .IWorkingSet

All known Subclasses:   org.eclipse.ui.internal .AbstractWorkingSet,
IWorkingSet
public interface IWorkingSet extends IPersistableElement,IAdaptable(Code)
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.

since:
   2.0 initial version
since:
   3.0 now extends org.eclipse.ui.IPersistableElement
since:
   3.2 now extends org.eclipse.core.runtime.IAdaptable

Method Summary
public IAdaptable[] adaptElements(IAdaptable[] objects)
     Transforms the supplied elements into elements that are suitable for containment in this working set.
public IAdaptable[] getElements()
     Returns the elements that are contained in this working set.
public String getId()
     Returns the working set id.
public ImageDescriptor getImage()
     Returns the working set icon. Currently, this is one of the icons specified in the extensions of the org.eclipse.ui.workingSets extension point.
public ImageDescriptor getImageDescriptor()
     Returns the working set icon. Currently, this is one of the icons specified in the extensions of the org.eclipse.ui.workingSets extension point.
public String getLabel()
     Return the name of this working set, formated for the end user.
public String getName()
     Returns the name of the working set.
public boolean isAggregateWorkingSet()
     Returns whether this working set is an aggregate working set or not.
It is recommended that clients of aggregate working sets treat them in a specific way.
public boolean isEditable()
     Returns whether this working set can be edited or not.
public boolean isEmpty()
     Returns whether this working set is currently empty (has no elements).
public boolean isSelfUpdating()
     Returns true if this working set is capable of updating itself and reacting to changes in the state of its members.
public boolean isVisible()
     Returns whether this working set should be shown in user interface components that list working sets by name.
public void setElements(IAdaptable[] elements)
     Sets the elements that are contained in this working set.
public void setId(String id)
     Sets the working set id.
public void setLabel(String label)
     Set the name of this working set, formated for the end user.
Parameters:
  label - the label for this working set.
public void setName(String name)
     Sets the name of the working set.

Method Detail
adaptElements
public IAdaptable[] adaptElements(IAdaptable[] objects)(Code)
Transforms the supplied elements into elements that are suitable for containment in this working set. This is useful for UI elements which wish to filter contributions to working sets based on applicability. This is a hint, however, and is not considered when the IWorkingSet.setElements(IAdaptable[]) method is invoked.
Parameters:
  objects - the objects to transform an array of transformed elements that be empty if no elementsfrom the original array are suitable
since:
   3.3
See Also:   org.eclipse.ui.IWorkingSetElementAdapter
See Also:   org.eclipse.ui.BasicWorkingSetElementAdapter

getElements
public IAdaptable[] getElements()(Code)
Returns the elements that are contained in this working set. the working set's elements

getId
public String getId()(Code)
Returns the working set id. Returns 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. the working set id. May be null
since:
   2.1

getImage
public ImageDescriptor getImage()(Code)
Returns the working set icon. Currently, this is one of the icons specified in the extensions of the org.eclipse.ui.workingSets extension point. The extension is identified using the value returned by getId(). Returns null if no icon has been specified in the extension or if getId() returns null. the working set icon or null.
since:
   2.1 IWorkingSet.getImageDescriptor()

getImageDescriptor
public ImageDescriptor getImageDescriptor()(Code)
Returns the working set icon. Currently, this is one of the icons specified in the extensions of the org.eclipse.ui.workingSets extension point. The extension is identified using the value returned by getId(). Returns null if no icon has been specified in the extension or if getId() returns null. the working set icon or null.
since:
   3.3

getLabel
public String getLabel()(Code)
Return the name of this working set, formated for the end user. Often this value is the same as the one returned from IWorkingSet.getName() . the name of this working set, formated for the end user
since:
   3.2

getName
public String getName()(Code)
Returns the name of the working set. the name of the working set

isAggregateWorkingSet
public boolean isAggregateWorkingSet()(Code)
Returns whether this working set is an aggregate working set or not.
It is recommended that clients of aggregate working sets treat them in a specific way. Please see the documentation for IWorkbenchPage.getAggregateWorkingSet for details. whether this working set is an aggregate working set or not
since:
   3.2

isEditable
public boolean isEditable()(Code)
Returns whether this working set can be edited or not. To make a working set editable the attribute pageClass of the extension defining a working set must be provided. true if the working set can be edited; otherwisefalse
since:
   3.1

isEmpty
public boolean isEmpty()(Code)
Returns whether this working set is currently empty (has no elements). whether this working set is currently empty
since:
   3.2

isSelfUpdating
public boolean isSelfUpdating()(Code)
Returns 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. whether the set is self-updating or not
since:
   3.2

isVisible
public boolean isVisible()(Code)
Returns whether this working set should be shown in user interface components that list working sets by name. true if the working set should be shown in theuser interface; otherwise false
since:
   3.2

setElements
public void setElements(IAdaptable[] elements)(Code)
Sets the elements that are contained in this working set.
Parameters:
  elements - the elements to set in this working set
since:
   3.3 it is now recommended that all calls to this method pass
since:
   through the results from callingIWorkingSet.adaptElements(IAdaptable[])
since:
   with the desired elements.

setId
public void setId(String id)(Code)
Sets the working set id. 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.
Parameters:
  id - the working set id. May be null
since:
   2.1

setLabel
public void setLabel(String label)(Code)
Set the name of this working set, formated for the end user.
Parameters:
  label - the label for this working set. If null issupplied then the value of IWorkingSet.getName() will be used.
since:
   3.2

setName
public void setName(String name)(Code)
Sets the name of the working set. The working set name should be unique. The working set name must not have leading or trailing whitespace.
Parameters:
  name - the name of the working set

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.