ITemplateSection

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> eclipse >> pde >> ui >> [ templates overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.eclipse.pde.ui.templates.ITemplateSection

SOURCE |

Download org.eclipse.pde.ui.templates.ITemplateSection

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.pde.ui.templates
Interface ITemplateSection

All Known Implementing Classes:: AbstractTemplateSection

public interface ITemplateSection

This interface represents a section of the template wizard that generates a new extension or plug-in. Typically, it maps to one wizard page, but more complex sections may span several pages. Also note that in the very simple cases it may not contribute any wizard pages.

If a section generates extensions, it should be written in such a way to be used both in the 'New Extension' wizard and as a part of a new plug-in project wizard. When used as part of the new plug-in project wizard, it may appear alongside other templates and therefore should not do anything that prevents it.

Since:: 2.0

Method Summary

void addPages(org.eclipse.jface.wizard.Wizard wizard)
          Adds template-related pages to the wizard.

void execute(org.eclipse.core.resources.IProject project, org.eclipse.pde.core.plugin.IPluginModelBase model, org.eclipse.core.runtime.IProgressMonitor monitor)
          Executes the template.

org.eclipse.pde.core.plugin.IPluginReference[] getDependencies(java.lang.String schemaVersion)
          Provides the list of template dependencies.

java.lang.String getDescription()
          Returns a description of the section.

java.lang.String getLabel()
          Returns a presentable label the section.

java.lang.String[] getNewFiles()
          Returns an array of tokens representing new files and folders created by this template section.

int getNumberOfWorkUnits()
          Returns the number of work units that this template will consume during the execution.

org.eclipse.jface.wizard.WizardPage getPage(int pageIndex)
          Returns a wizard page at the provided index.

int getPageCount()
          Returns number of pages that are contributed by this template.

boolean getPagesAdded()
          Tests whether this template have had a chance to create its pages.

java.lang.String getReplacementString(java.lang.String fileName, java.lang.String key)
          Returns a replacement string for the provided key.

java.net.URL getTemplateLocation()
          Returns the URL of the zip file containing template files and directories that will be created in the plug-in project.

java.lang.String getUsedExtensionPoint()
          Returns identifier of the extension point used in this section.

Method Detail

getTemplateLocation

public java.net.URL getTemplateLocation()

Returns the URL of the zip file containing template files and directories that will be created in the plug-in project. If URL protocol is 'file', and the URL ends with a trailing file separator, an attempt will be made to treat the URL as a root directory and iterate using standard Java I/O classes. If template files are stored in a ZIP or JAR archive, the name of the archive must be part of the URL.

getLabel

public java.lang.String getLabel()

Returns a presentable label the section.

getDescription

public java.lang.String getDescription()

Returns a description of the section. The description should explain what extension will be used, what classes will be generated and how to test that the generated code works properly.

getReplacementString

public java.lang.String getReplacementString(java.lang.String fileName,
                                             java.lang.String key)

Returns a replacement string for the provided key. When a token is found in the template file with a form '$key$', the actual key is passed to this method to obtain the replacement. If replacement is provided, it is substituted for the token (including the '$' characters). Otherwise, it is transfered as-is.

addPages

public void addPages(org.eclipse.jface.wizard.Wizard wizard)

Adds template-related pages to the wizard. A typical section implementation contributes one page, but complex sections may span several pages.

getPage

public org.eclipse.jface.wizard.WizardPage getPage(int pageIndex)

Returns a wizard page at the provided index.

getPageCount

public int getPageCount()

Returns number of pages that are contributed by this template.

getPagesAdded

public boolean getPagesAdded()

Tests whether this template have had a chance to create its pages. This method returns true after 'addPages' has been called.

getNumberOfWorkUnits

public int getNumberOfWorkUnits()

Returns the number of work units that this template will consume during the execution. This number is used to calculate the total number of work units when initializing the progress indicator.

getDependencies

public org.eclipse.pde.core.plugin.IPluginReference[] getDependencies(java.lang.String schemaVersion)

Provides the list of template dependencies. A template may generate a number of Java classes that reference classes and interfaces from other plug-ins. By providing this list, a template enables the template wizard to create the correct Java build path so that these classes and interfaces are correctly resolved.

getUsedExtensionPoint

public java.lang.String getUsedExtensionPoint()

Returns identifier of the extension point used in this section.

execute

public void execute(org.eclipse.core.resources.IProject project,
                    org.eclipse.pde.core.plugin.IPluginModelBase model,
                    org.eclipse.core.runtime.IProgressMonitor monitor)
             throws org.eclipse.core.runtime.CoreException

Executes the template. As part of the execution, template may generate resources under the provided project, and/or modify the plug-in model.

getNewFiles

public java.lang.String[] getNewFiles()

Returns an array of tokens representing new files and folders created by this template section. The information is collected for the benefit of build.properties file so that the generated files and folders are included in the binary build. The tokens will be added as-is to the variable . For this reason, wild cards and other syntax rules applicable to this variable can be used in this method. For example:

 return new String[]{"/icons/*.gif"};