Java Doc for ProjectConfigurationProvider.java in  » IDE-Netbeans » project.ant » org » netbeans » spi » project » 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 Netbeans » project.ant » org.netbeans.spi.project 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.netbeans.spi.project.ProjectConfigurationProvider

ProjectConfigurationProvider
public interface ProjectConfigurationProvider (Code)
Provider of configurations for a project. Should be registered in a project's org.netbeans.api.project.Project.getLookup lookup . Besides the implementor, only the project UI infrastructure is expected to use this class.
Parameters:
  C - the type of configuration created by this provider
author:
   Adam Sotona, Jesse Glick
since:
   org.netbeans.modules.projectapi/1 1.11
See Also:    Project Configurations design document


Field Summary
 StringPROP_CONFIGURATIONS
     Property name of the set of configurations.
 StringPROP_CONFIGURATION_ACTIVE
     Property name for the active configuration.


Method Summary
 voidaddPropertyChangeListener(PropertyChangeListener lst)
     Adds a listener to check for changes in ProjectConfigurationProvider.PROP_CONFIGURATION_ACTIVE or ProjectConfigurationProvider.PROP_CONFIGURATIONS .
 booleanconfigurationsAffectAction(String command)
     Indicates if a project action is affected by the choice of configuration.
 voidcustomize()
     Customize this project's configurations.
 CgetActiveConfiguration()
     Gets the currently active configuration.
 Collection<C>getConfigurations()
     Gets a list of configurations.
 booleanhasCustomizer()
     Checks if this project can provide a GUI customizer for its configurations.
 voidremovePropertyChangeListener(PropertyChangeListener lst)
     Removes a listener.
 voidsetActiveConfiguration(C configuration)
     Sets the active configuration.

Field Detail
PROP_CONFIGURATIONS
String PROP_CONFIGURATIONS(Code)
Property name of the set of configurations. Use it when firing a change in the set of configurations.



PROP_CONFIGURATION_ACTIVE
String PROP_CONFIGURATION_ACTIVE(Code)
Property name for the active configuration. Use it when firing a change in the active configuration.





Method Detail
addPropertyChangeListener
void addPropertyChangeListener(PropertyChangeListener lst)(Code)
Adds a listener to check for changes in ProjectConfigurationProvider.PROP_CONFIGURATION_ACTIVE or ProjectConfigurationProvider.PROP_CONFIGURATIONS .
Parameters:
  lst - a listener to add



configurationsAffectAction
boolean configurationsAffectAction(String command)(Code)
Indicates if a project action is affected by the choice of configuration. If so, a GUI for this action is permitted to show a list of configurations and let the user select a configuration to apply to one action invocation only. Such a GUI can avoid the need to first select an active configuration and then run the action as two steps. This is done by including a ProjectConfiguration in the context passed to ActionProvider.invokeAction . A project is free to return false even if the configuration might affect the behavior of the action, if it simply does not wish for such a GUI to be shown.

The likely values of command are those actions normally shown in the IDE's tool bar with main project bindings: ActionProvider.COMMAND_BUILD , ActionProvider.COMMAND_REBUILD , ActionProvider.COMMAND_RUN , and ActionProvider.COMMAND_DEBUG .


Parameters:
  command - one of ActionProvider.getSupportedActions true if the named command refers to an action affected by configurations



customize
void customize()(Code)
Customize this project's configurations. Only permitted if ProjectConfigurationProvider.hasCustomizer is true. May, for example, open the project properties dialog.



getActiveConfiguration
C getActiveConfiguration()(Code)
Gets the currently active configuration.

Should be called within org.netbeans.api.project.ProjectManager.mutex read access . the active configuration for this project (should be a member of ProjectConfigurationProvider.getConfigurations, or null only if that is empty)




getConfigurations
Collection<C> getConfigurations()(Code)
Gets a list of configurations. Permitted to return different instances from one invocation to the next but it is advisable for the "same" instances to compare as equal.

Should be called within org.netbeans.api.project.ProjectManager.mutex read access . all available configurations for this project




hasCustomizer
boolean hasCustomizer()(Code)
Checks if this project can provide a GUI customizer for its configurations. true if ProjectConfigurationProvider.customize may be called



removePropertyChangeListener
void removePropertyChangeListener(PropertyChangeListener lst)(Code)
Removes a listener.
Parameters:
  lst - a listener to remove



setActiveConfiguration
void setActiveConfiguration(C configuration) throws IllegalArgumentException, IOException(Code)
Sets the active configuration. Should fire a change in ProjectConfigurationProvider.PROP_CONFIGURATION_ACTIVE . It should be true afterwards that configuration.equals(getActiveConfiguration()) though it might not be true that configuration == getActiveConfiguration().

If possible, the choice of configuration should be persisted for the next IDE session. If applicable, the persisted choice should be kept in per-user settings, not shared or versioned.

Should be called within org.netbeans.api.project.ProjectManager.mutex write access .
Parameters:
  configuration - new active configuration
throws:
  IllegalArgumentException - if the requested configuration is not a member of ProjectConfigurationProvider.getConfigurations
throws:
  IOException - if storing the configuration change failed




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