Java Doc for IWorkingSetManager.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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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.IWorkingSetManager

All known Subclasses:   org.eclipse.ui.internal.AbstractWorkingSetManager,  org.eclipse.ui.internal.WorkingSetManager,
IWorkingSetManager
public interface IWorkingSetManager (Code)
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.


See Also:   IWorkingSet
since:
   2.0 initial version
since:
   3.0 added createWorkingSet(IMemento)


Field Summary
final public static  StringCHANGE_WORKING_SET_ADD
     Change event id when a working set is added newValue of the PropertyChangeEvent will be the added working set.
final public static  StringCHANGE_WORKING_SET_CONTENT_CHANGE
     Change event id when the working set contents changed newValue of the PropertyChangeEvent will be the changed working set.
final public static  StringCHANGE_WORKING_SET_LABEL_CHANGE
     Change event id when the working set label changed.
final public static  StringCHANGE_WORKING_SET_NAME_CHANGE
     Change event id when the working set name changed.
final public static  StringCHANGE_WORKING_SET_REMOVE
     Change event id when a working set is removed newValue of the PropertyChangeEvent will be null.
final public static  StringCHANGE_WORKING_SET_UPDATER_INSTALLED
     Change event id when a working set updater got installed.
final public static  StringCHANGE_WORKING_SET_UPDATER_UNINSTALLED
     Change event id when a working set updater got uninstalled.


Method Summary
public  voidaddPropertyChangeListener(IPropertyChangeListener listener)
     Adds a property change listener.
public  voidaddRecentWorkingSet(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.
public  voidaddToWorkingSets(IAdaptable element, IWorkingSet[] workingSets)
     Utility method that will add the element to each given working set in workingSets if possible.
public  voidaddWorkingSet(IWorkingSet workingSet)
     Adds a working set to the receiver.
public  IWorkingSetcreateAggregateWorkingSet(String name, String label, IWorkingSet[] components)
     Create a working set that is the union of a collection of other working sets.
public  IWorkingSetcreateWorkingSet(String name, IAdaptable[] elements)
     Creates a new working set. The working set is not added to the working set manager.
Parameters:
  name - the name of the new working set.
public  IWorkingSetcreateWorkingSet(IMemento memento)
     Re-creates and returns a working set from the state captured within the given memento.
public  IWorkingSetEditWizardcreateWorkingSetEditWizard(IWorkingSet workingSet)
     Creates a working set edit wizard for the specified working set. The working set will already be set in the wizard. The caller is responsible for creating and opening a wizard dialog. Example: IWorkingSetEditWizard wizard = workingSetManager.createWorkingSetEditWizard(workingSet); if (wizard != null) { WizardDialog dialog = new WizardDialog(shell, wizard); dialog.create(); if (dialog.open() == Window.OK) { workingSet = wizard.getSelection(); } }
Parameters:
  workingSet - working set to create a working set edit wizard for.
public  IWorkingSetNewWizardcreateWorkingSetNewWizard(String[] workingSetIds)
     Creates a working set new wizard.
public  IWorkingSetSelectionDialogcreateWorkingSetSelectionDialog(Shell parent)
    
public  IWorkingSetSelectionDialogcreateWorkingSetSelectionDialog(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. The caller is responsible for opening the dialog with IWorkingSetSelectionDialog#open, and subsequently extracting the selected working sets using IWorkingSetSelectionDialog#getSelection.
Parameters:
  parentShell - the parent shell of the working set selection dialog
Parameters:
  multi - true=more than one working set can be chosen in the dialog.
public  IWorkingSetSelectionDialogcreateWorkingSetSelectionDialog(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. The caller is responsible for opening the dialog with IWorkingSetSelectionDialog#open, and subsequently extracting the selected working sets using IWorkingSetSelectionDialog#getSelection.
Parameters:
  parentShell - the parent shell of the working set selection dialog
Parameters:
  multi - true=more than one working set can be chosen in the dialog.
public  voiddispose()
     Disposes the working set manager.
public  IWorkingSet[]getAllWorkingSets()
     Returns an array of all working sets stored in the receiver including those that are marked as being not visible.
public  IWorkingSet[]getRecentWorkingSets()
     Returns the list of most recently used working sets.
public  IWorkingSetgetWorkingSet(String name)
     Returns the working set with the specified name.
public  IWorkingSet[]getWorkingSets()
     Returns an array of all working sets stored in the receiver.
public  voidremovePropertyChangeListener(IPropertyChangeListener listener)
     Removes the property change listener.
public  voidremoveWorkingSet(IWorkingSet workingSet)
    

Field Detail
CHANGE_WORKING_SET_ADD
final public static String CHANGE_WORKING_SET_ADD(Code)
Change event id when a working set is added newValue of the PropertyChangeEvent will be the added working set. oldValue will be null.
See Also:   IPropertyChangeListener



CHANGE_WORKING_SET_CONTENT_CHANGE
final public static String CHANGE_WORKING_SET_CONTENT_CHANGE(Code)
Change event id when the working set contents changed newValue of the PropertyChangeEvent will be the changed working set. oldValue will be null.
See Also:   IPropertyChangeListener



CHANGE_WORKING_SET_LABEL_CHANGE
final public static String CHANGE_WORKING_SET_LABEL_CHANGE(Code)
Change event id when the working set label changed. newValue of the PropertyChangeEvent will be the changed working set. oldValue will be null.
See Also:   IPropertyChangeListener
since:
   3.2



CHANGE_WORKING_SET_NAME_CHANGE
final public static String CHANGE_WORKING_SET_NAME_CHANGE(Code)
Change event id when the working set name changed. newValue of the PropertyChangeEvent will be the changed working set. oldValue will be null.
See Also:   IPropertyChangeListener



CHANGE_WORKING_SET_REMOVE
final public static String CHANGE_WORKING_SET_REMOVE(Code)
Change event id when a working set is removed newValue of the PropertyChangeEvent will be null. oldValue will be the removed working set.
See Also:   IPropertyChangeListener



CHANGE_WORKING_SET_UPDATER_INSTALLED
final public static String CHANGE_WORKING_SET_UPDATER_INSTALLED(Code)
Change event id when a working set updater got installed. NewValue of the PropertyChangeEvent will be the installed updater. OldValue will be null
since:
   3.1



CHANGE_WORKING_SET_UPDATER_UNINSTALLED
final public static String CHANGE_WORKING_SET_UPDATER_UNINSTALLED(Code)
Change event id when a working set updater got uninstalled. NewValue will be null OldValue of the PropertyChangeEvent will be the uninstalled updater.
since:
   3.3





Method Detail
addPropertyChangeListener
public void addPropertyChangeListener(IPropertyChangeListener listener)(Code)
Adds a property change listener.
Parameters:
  listener - the property change listener to add



addRecentWorkingSet
public void addRecentWorkingSet(IWorkingSet workingSet)(Code)
Adds a working set to the top of the list of most recently used working sets, making it the most recently used working set. The last (oldest) item will be deleted if the list exceeds the size limit.
Parameters:
  workingSet - the working set to add to the list of most recently used working sets.



addToWorkingSets
public void addToWorkingSets(IAdaptable element, IWorkingSet[] workingSets)(Code)
Utility method that will add the element to each given working set in workingSets if possible. This method will invoke IWorkingSet.adaptElements(IAdaptable[]) for the element on each working set and the result of this method will be used rather than the original element in the addition operation.
Parameters:
  element - the element to adapt and then add to the working sets
Parameters:
  workingSets - the working sets to add the element to
since:
   3.4



addWorkingSet
public void addWorkingSet(IWorkingSet workingSet)(Code)
Adds a working set to the receiver. The working set must not exist yet.
Parameters:
  workingSet - the working set to add



createAggregateWorkingSet
public IWorkingSet createAggregateWorkingSet(String name, String label, IWorkingSet[] components)(Code)
Create a working set that is the union of a collection of other working sets. One connected (via IWorkingSetManager.addWorkingSet(IWorkingSet) this working set will be automatically updated to reflect the contents of the component sets, should they themselves change.
Parameters:
  name - the name of the new working set. Should not have leading ortrailing whitespace.
Parameters:
  label - the user-friendly label the working set
Parameters:
  components - the component working sets a new working set with the specified name and content
since:
   3.2



createWorkingSet
public IWorkingSet createWorkingSet(String name, IAdaptable[] elements)(Code)
Creates a new working set. The working set is not added to the working set manager.
Parameters:
  name - the name of the new working set. Should not have leading or trailing whitespace.
Parameters:
  elements - the working set contents a new working set with the specified name and content



createWorkingSet
public IWorkingSet createWorkingSet(IMemento memento)(Code)
Re-creates and returns a working set from the state captured within the given memento.
Parameters:
  memento - a memento containing the state for the working set the restored working set, or null if it could not be created
since:
   3.0



createWorkingSetEditWizard
public IWorkingSetEditWizard createWorkingSetEditWizard(IWorkingSet workingSet)(Code)
Creates a working set edit wizard for the specified working set. The working set will already be set in the wizard. The caller is responsible for creating and opening a wizard dialog. Example: IWorkingSetEditWizard wizard = workingSetManager.createWorkingSetEditWizard(workingSet); if (wizard != null) { WizardDialog dialog = new WizardDialog(shell, wizard); dialog.create(); if (dialog.open() == Window.OK) { workingSet = wizard.getSelection(); } }
Parameters:
  workingSet - working set to create a working set edit wizard for. a working set edit wizard to edit the specified working setor null if no edit wizard has been defined for theworking 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.
since:
   2.1



createWorkingSetNewWizard
public IWorkingSetNewWizard createWorkingSetNewWizard(String[] workingSetIds)(Code)
Creates a working set new wizard. The wizard will allow creating new working sets. Returns 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) { ... } }


Parameters:
  workingSetIds - a list of working set ids which are valid workings setsto be created or null if all currently available working set typesare valid the working set new wizard or null
since:
   3.1



createWorkingSetSelectionDialog
public IWorkingSetSelectionDialog createWorkingSetSelectionDialog(Shell parent)(Code)

Parameters:
  parent - the parent shell the dialog



createWorkingSetSelectionDialog
public IWorkingSetSelectionDialog createWorkingSetSelectionDialog(Shell parentShell, boolean multi)(Code)
Creates a working set selection dialog that lists all working sets and allows the user to add, remove and edit working sets. The caller is responsible for opening the dialog with IWorkingSetSelectionDialog#open, and subsequently extracting the selected working sets using IWorkingSetSelectionDialog#getSelection.
Parameters:
  parentShell - the parent shell of the working set selection dialog
Parameters:
  multi - true=more than one working set can be chosen in the dialog. false=only one working set can be chosen. Multipleworking sets can still be selected and removed from the list butthe dialog can only be closed when a single working set is selected. a working set selection dialog



createWorkingSetSelectionDialog
public IWorkingSetSelectionDialog createWorkingSetSelectionDialog(Shell parentShell, boolean multi, String[] workingsSetIds)(Code)
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. The caller is responsible for opening the dialog with IWorkingSetSelectionDialog#open, and subsequently extracting the selected working sets using IWorkingSetSelectionDialog#getSelection.
Parameters:
  parentShell - the parent shell of the working set selection dialog
Parameters:
  multi - true=more than one working set can be chosen in the dialog. false=only one working set can be chosen. Multipleworking sets can still be selected and removed from the list butthe dialog can only be closed when a single working set is selected.
Parameters:
  workingsSetIds - a list of working set ids which are valid workings setsto be selected, created, removed or edited, or null if all currentlyavailable working set types are valid a working set selection dialog
since:
   3.1



dispose
public void dispose()(Code)
Disposes the working set manager.
since:
   3.1



getAllWorkingSets
public IWorkingSet[] getAllWorkingSets()(Code)
Returns an array of all working sets stored in the receiver including those that are marked as being not visible.
See Also:   IWorkingSet.isVisible the working sets stored in the receiver
since:
   3.2



getRecentWorkingSets
public IWorkingSet[] getRecentWorkingSets()(Code)
Returns the list of most recently used working sets. The most recently used working set appears first in the list. the list of most recently used working sets



getWorkingSet
public IWorkingSet getWorkingSet(String name)(Code)
Returns the working set with the specified name. Returns null if there is no working set with that name.
Parameters:
  name - the name of the working set to return the working set with the specified name.



getWorkingSets
public IWorkingSet[] getWorkingSets()(Code)
Returns an array of all working sets stored in the receiver. Any working set whose IWorkingSet.isVisible method returns false will not be included in this array. For a complete list of working sets please use IWorkingSetManager.getAllWorkingSets() . the working sets stored in the receiver



removePropertyChangeListener
public void removePropertyChangeListener(IPropertyChangeListener listener)(Code)
Removes the property change listener.
Parameters:
  listener - the property change listener to remove



removeWorkingSet
public void removeWorkingSet(IWorkingSet workingSet)(Code)
Removes the working set
Parameters:
  workingSet - the working set to remove



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.