Java Doc for IProgressConstants.java in  » IDE-Eclipse » ui-workbench » org » eclipse » ui » progress » 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.progress 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.eclipse.ui.progress.IProgressConstants

IProgressConstants
public interface IProgressConstants (Code)
Constants relating to progress UI functionality of the workbench plug-in.

The four constants define property keys that are used to associate UI related information with Jobs (org.eclipse.core.runtime.jobs.Job).
See Also:   org.eclipse.core.runtime.jobs.Job.setProperty
since:
   3.0



Field Summary
final public static  QualifiedNameACTION_PROPERTY
     This property is used to associate an IAction with a Job.
final public static  QualifiedNameICON_PROPERTY
     This property is used to associate an ImageDescriptor with a Job.
final public static  QualifiedNameKEEPONE_PROPERTY
     The KEEPONE_PROPERTY is an extension to the KEEP_PROPERTY, that provides a hint to the progress UI to ensure that only a single Job of a Job family is kept in the set of kept Jobs.
final public static  QualifiedNameKEEP_PROPERTY
     This property provides a hint to the progress UI to keep Jobs in the UI after they have finished.
final public static  QualifiedNameNO_IMMEDIATE_ERROR_PROMPT_PROPERTY
     This property provides a hint to the progress UI to not prompt on errors immediately but instead make the errors available through the progress UI.
public static  StringPROGRESS_VIEW_ID
     Constant for the progress view id.
final public static  QualifiedNamePROPERTY_IN_DIALOG
     This is a property set on a user job if the user has not decided to run the job in the background.
final static  StringPROPERTY_PREFIX
     Common prefix for properties defined in this interface.



Field Detail
ACTION_PROPERTY
final public static QualifiedName ACTION_PROPERTY(Code)
This property is used to associate an IAction with a Job. If the Job is shown in the UI, the action might be represented as a button or hyper link to allow the user to trigger a job specific action, like showing the Job's results.

The progress UI will track the enabled state of the action and its tooltip text.

If the action implements ActionFactory.IWorkbenchAction, its dispose method will be called as soon as the Job is finally removed from the set of kept jobs.


See Also:   org.eclipse.jface.action.IAction
See Also:   org.eclipse.ui.actions.ActionFactory.IWorkbenchAction



ICON_PROPERTY
final public static QualifiedName ICON_PROPERTY(Code)
This property is used to associate an ImageDescriptor with a Job. If the Job is shown in the UI, this descriptor is used to create an icon that represents the Job.

Please note, that this property is only used if no ImageDescriptor has been registered for the Job family with the IProgressService.


See Also:   org.eclipse.jface.resource.ImageDescriptor
See Also:   org.eclipse.ui.progress.IProgressService



KEEPONE_PROPERTY
final public static QualifiedName KEEPONE_PROPERTY(Code)
The KEEPONE_PROPERTY is an extension to the KEEP_PROPERTY, that provides a hint to the progress UI to ensure that only a single Job of a Job family is kept in the set of kept Jobs. That is, whenever a Job that has the KEEPONE_PROPERTY starts or finishes, all other kept Jobs of the same family are removed first.

Membership to family is determined using a Job's belongsTo method. The progress service will pass each job that currently exists in the view to the belongsTo method of a newly added job. Clients who set the KEEPONE_PROPERTY must implement a belongsTo method that determines if the passed job is of the same family as their job and return true if it is.

Please note that other Jobs of the same family are only removed if they have finished. Non finished jobs of the same family are left alone.




KEEP_PROPERTY
final public static QualifiedName KEEP_PROPERTY(Code)
This property provides a hint to the progress UI to keep Jobs in the UI after they have finished. This can be used to communicate results of a Job back to the user.

The property must be of type Boolean and the hint is used if its value is true.




NO_IMMEDIATE_ERROR_PROMPT_PROPERTY
final public static QualifiedName NO_IMMEDIATE_ERROR_PROMPT_PROPERTY(Code)
This property provides a hint to the progress UI to not prompt on errors immediately but instead make the errors available through the progress UI.

The property must be of type Boolean and the hint is used if its value is true.


since:
   3.1



PROGRESS_VIEW_ID
public static String PROGRESS_VIEW_ID(Code)
Constant for the progress view id.



PROPERTY_IN_DIALOG
final public static QualifiedName PROPERTY_IN_DIALOG(Code)
This is a property set on a user job if the user has not decided to run the job in the background. The value is set to true when the job starts and set to false if the user subsequently decides to complete the job in the background.

This property is not intended to be set by clients.


See Also:   org.eclipse.core.runtime.jobs.Job.isUser



PROPERTY_PREFIX
final static String PROPERTY_PREFIX(Code)
Common prefix for properties defined in this interface.





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