Java Doc for AbstractTemplateSection.java in  » IDE-Eclipse » Eclipse-plug-in-development » org » eclipse » pde » ui » templates » 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 » Eclipse plug in development » org.eclipse.pde.ui.templates 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.eclipse.pde.ui.templates.AbstractTemplateSection

All known Subclasses:   org.eclipse.pde.ui.templates.BaseOptionTemplateSection,
AbstractTemplateSection
abstract public class AbstractTemplateSection implements ITemplateSection,IVariableProvider(Code)
Common function for template sections. It is recommended to subclass this class rather than implementing ITemplateSection directly when providing extension templates.
since:
   2.0


Field Summary
final public static  StringKEY_ACTIVATOR_SIMPLE
    
final public static  StringKEY_PACKAGE_NAME
     The key for the package name that will be created by this teamplate (value="packageName").
final public static  StringKEY_PLUGIN_CLASS
     The key for the main plug-in class of the plug-in that the template is used for (value="pluginClass").
final public static  StringKEY_PLUGIN_ID
     The key for the plug-in id of the plug-in that the template is used for (value="pluginId").
final public static  StringKEY_PLUGIN_NAME
     The key for the plug-in name of the plug-in that the template is used for (value="pluginName").
protected  IPluginModelBasemodel
     The plug-in model.
protected  IProjectproject
     The project handle.


Method Summary
public  voidaddPages(Wizard wizard)
    
protected  IPluginExtensioncreateExtension(String pointId, boolean reuse)
     A utility method to create an extension object for the plug-in model from the provided extension point id.
Parameters:
  pointId - the identifier of the target extension point
Parameters:
  reuse - if true, new extension object will be created only if anextension with the same Id does not exist.
public  voidexecute(IProject project, IPluginModelBase model, IProgressMonitor monitor)
     The default implementation of the interface method.
protected  voidgenerateFiles(IProgressMonitor monitor)
     Generates files as part of the template execution.
protected  voidgenerateFiles(IProgressMonitor monitor, URL locationUrl)
     Generates files as part of the template execution. The files found in the location are processed in the following way:
  • Files and folders found in the directory bin are copied into the target project without modification.
  • Files found in the directory java are copied into the Java source folder by creating the folder structure that corresponds to the package name (variable packageName ).
public  IPluginReference[]getDependencies(String schemaVersion)
    
public  StringgetDescription()
    
public  intgetNumberOfWorkUnits()
     The default implementation of the interface method.
public  booleangetPagesAdded()
     Tests if wizard pages for this template section have been added.
abstract protected  ResourceBundlegetPluginResourceBundle()
     An abstract method that returns the resource bundle that corresponds to the best match of plugin.properties file for the current locale (in case of fragments, the file is fragment.properties ).
public  StringgetPluginResourceString(String key)
     Returns the translated version of the resource string represented by the provided key.
public  StringgetReplacementString(String fileName, String key)
     The default implementation of this method provides values of the following keys: pluginClass , pluginId and pluginName .
protected  IFoldergetSourceFolder(IProgressMonitor monitor)
     Returns the folder with Java files in the target project.
protected  doublegetTargetVersion()
    
public  URLgetTemplateLocation()
    
public  ObjectgetValue(String key)
    
protected  booleanisOkToCreateFile(File sourceFile)
     Tests if the file found in the template location should be created in the target project.
protected  booleanisOkToCreateFolder(File sourceFolder)
     Tests if the folder found in the template location should be created in the target project.
protected  voidmarkPagesAdded()
     Marks that pages have been added to the wizard by this template.
abstract protected  voidupdateModel(IProgressMonitor monitor)
     Subclass must implement this method to add the required entries in the plug-in model.

Field Detail
KEY_ACTIVATOR_SIMPLE
final public static String KEY_ACTIVATOR_SIMPLE(Code)
The key for the simple class name of a bundle activator (value="activator")
since:
   3.3



KEY_PACKAGE_NAME
final public static String KEY_PACKAGE_NAME(Code)
The key for the package name that will be created by this teamplate (value="packageName").



KEY_PLUGIN_CLASS
final public static String KEY_PLUGIN_CLASS(Code)
The key for the main plug-in class of the plug-in that the template is used for (value="pluginClass"). The return value is a fully-qualified class name.



KEY_PLUGIN_ID
final public static String KEY_PLUGIN_ID(Code)
The key for the plug-in id of the plug-in that the template is used for (value="pluginId").



KEY_PLUGIN_NAME
final public static String KEY_PLUGIN_NAME(Code)
The key for the plug-in name of the plug-in that the template is used for (value="pluginName").



model
protected IPluginModelBase model(Code)
The plug-in model.



project
protected IProject project(Code)
The project handle.





Method Detail
addPages
public void addPages(Wizard wizard)(Code)



createExtension
protected IPluginExtension createExtension(String pointId, boolean reuse) throws CoreException(Code)
A utility method to create an extension object for the plug-in model from the provided extension point id.
Parameters:
  pointId - the identifier of the target extension point
Parameters:
  reuse - if true, new extension object will be created only if anextension with the same Id does not exist. an existing extension (if exists and reuse istrue ), or a new extension object otherwise.



execute
public void execute(IProject project, IPluginModelBase model, IProgressMonitor monitor) throws CoreException(Code)
The default implementation of the interface method. It will generate required files found in the template location and then call updateModel to add the required manifest entires.
See Also:   ITemplateSection.execute(IProjectIPluginModelBaseIProgressMonitor)



generateFiles
protected void generateFiles(IProgressMonitor monitor) throws CoreException(Code)
Generates files as part of the template execution. The default implementation uses template location as a root of the file templates. AbstractTemplateSection.generateFiles(IProgressMonitor monitor,URL locationUrl) on how the location gets processed.
Parameters:
  monitor - progress monitor to use to indicate generation progress



generateFiles
protected void generateFiles(IProgressMonitor monitor, URL locationUrl) throws CoreException(Code)
Generates files as part of the template execution. The files found in the location are processed in the following way:
  • Files and folders found in the directory bin are copied into the target project without modification.
  • Files found in the directory java are copied into the Java source folder by creating the folder structure that corresponds to the package name (variable packageName ). Java files are subject to conditional generation and variable replacement.
  • All other files and folders are copied directly into the target folder with the conditional generation and variable replacement for files. Variable replacement also includes file names.

since:
   3.3
Parameters:
  monitor - progress monitor to use to indicate generation progress
Parameters:
  locationUrl - a url pointing to a file/directory that will be copied into the template



getDependencies
public IPluginReference[] getDependencies(String schemaVersion)(Code)



getDescription
public String getDescription()(Code)

See Also:   ITemplateSection.getDescription



getNumberOfWorkUnits
public int getNumberOfWorkUnits()(Code)
The default implementation of the interface method. The returned value is 1.
See Also:   ITemplateSection.getNumberOfWorkUnits



getPagesAdded
public boolean getPagesAdded()(Code)
Tests if wizard pages for this template section have been added. true if wizard pages for this section have beenadded, false otherwise.



getPluginResourceBundle
abstract protected ResourceBundle getPluginResourceBundle()(Code)
An abstract method that returns the resource bundle that corresponds to the best match of plugin.properties file for the current locale (in case of fragments, the file is fragment.properties ). resource bundle for plug-in properties file or null if not found.



getPluginResourceString
public String getPluginResourceString(String key)(Code)
Returns the translated version of the resource string represented by the provided key.
Parameters:
  key - the key of the required resource string the translated version of the required resource string
See Also:   AbstractTemplateSection.getPluginResourceBundle()



getReplacementString
public String getReplacementString(String fileName, String key)(Code)
The default implementation of this method provides values of the following keys: pluginClass , pluginId and pluginName .
See Also:   ITemplateSection.getReplacementString(StringString)



getSourceFolder
protected IFolder getSourceFolder(IProgressMonitor monitor) throws CoreException(Code)
Returns the folder with Java files in the target project. The default implementation looks for source folders in the classpath of the target folders and picks the first one encountered. Subclasses may override this behaviour.
Parameters:
  monitor - progress monitor to use source folder that will be used to generate Java files ornull if none found.



getTargetVersion
protected double getTargetVersion()(Code)



getTemplateLocation
public URL getTemplateLocation()(Code)

See Also:   ITemplateSection.getTemplateLocation



getValue
public Object getValue(String key)(Code)

See Also:   IVariableProvider.getValue(String)



isOkToCreateFile
protected boolean isOkToCreateFile(File sourceFile)(Code)
Tests if the file found in the template location should be created in the target project. Subclasses may use this method to conditionally block creation of the file (subject to user choices).
Parameters:
  sourceFile - the file found in the template location that needs to becreated. true if the specified file should be created in theproject or false to skip it. The defaultimplementation is true .



isOkToCreateFolder
protected boolean isOkToCreateFolder(File sourceFolder)(Code)
Tests if the folder found in the template location should be created in the target project. Subclasses may use this method to conditionally block the creation of entire directories (subject to user choices).
Parameters:
  sourceFolder - the folder that is tested true if the provided folder should be created inthe workspace, false if the values of thesubstitution variables indicate otherwise.



markPagesAdded
protected void markPagesAdded()(Code)
Marks that pages have been added to the wizard by this template. Call this method in 'addPages'.
See Also:   AbstractTemplateSection.addPages(Wizard)



updateModel
abstract protected void updateModel(IProgressMonitor monitor) throws CoreException(Code)
Subclass must implement this method to add the required entries in the plug-in model.
Parameters:
  monitor - the progress monitor to be used



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

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