| java.lang.Object
 org.eclipse.pde.ui.templates.AbstractTemplateSection
org.eclipse.pde.ui.templates.BaseOptionTemplateSection
org.eclipse.pde.ui.templates.OptionTemplateSection
All known Subclasses: org.eclipse.pde.internal.ui.templates.PDETemplateSection,
| OptionTemplateSection | | abstract public class OptionTemplateSection extends BaseOptionTemplateSection (Code) | | This class adds some conventions to the class it is based on. For example, it
expects to find the template content in the following location:
[install location]/[templateDirectory]/[sectionId]
where templateDirectory is expected to be 'templates_3.0' (to
distinguish from template designed for earlier Eclipse versions), and
sectionId is the unique identifier as reported by the template
section.
It also assumes that all wizard pages associated with this template will be
based on OptionTemplateWizardPage.
since:
2.0 |
| Method Summary | |
| public WizardPage | createPage(int pageIndex)
Creates the wizard page for the specified page index. | | public WizardPage | createPage(int pageIndex, String helpContextId)
Creates the wizard page for the specified page index. | | protected void | flagMissingRequiredOption(TemplateOption option)
Locates the page that this option is presented in and flags that the
option is required and is currently not set. | | public String | getDescription()
Returns the description of this template to be used in the UI. | | abstract protected URL | getInstallURL()
Returns the install URL of the plug-in that contributes this template. | | public String | getLabel()
Returns the label of this template to be used in the UI. | | public TemplateOption[] | getOptions(int pageIndex)
Returns options that belong to the page with the given index. | | public TemplateOption[] | getOptions(WizardPage page)
Returns options that are added to the provided wizard page. | | public WizardPage | getPage(int pageIndex)
Returns the wizard page at the specified index. | | public int | getPageCount()
Returns a number of pages that this template contributes to the wizard. | | public int | getPageIndex(TemplateOption option)
Returns the zero-based index of a page that hosts the the given option. | | abstract public String | getSectionId()
Returns the unique name of this section. | | protected String | getTemplateDirectory()
Returns the directory where all the templates are located in the
contributing plug-in. | | public URL | getTemplateLocation()
| | protected void | registerOption(TemplateOption option, Object value, int pageIndex)
| | protected void | resetPageState()
Resets the current page state by clearing the error message and making
the page complete, thereby allowing users to flip to the next page. | | public void | setPageCount(int count)
Sets the number of pages this template will manage. | | public void | validateOptions(TemplateOption source)
|
| OptionTemplateSection | | public OptionTemplateSection()(Code) | | The default constructor.
|
| createPage | | public WizardPage createPage(int pageIndex)(Code) | | Creates the wizard page for the specified page index. This method cannot
be called before setPageCount(int). The page will be created with all the
options registered for that page index. Therefore, make all the calls to
addOption() before calling this method.
Parameters:
pageIndex - a zero-based index of the page relative to this template. Forexample, if a template needs to have two pages, you have tocall this method twice (once with index 0 and again with index1).
See Also: OptionTemplateSection.setPageCount(int)
See Also: BaseOptionTemplateSection.addOption |
| createPage | | public WizardPage createPage(int pageIndex, String helpContextId)(Code) | | Creates the wizard page for the specified page index. This method cannot
be called before setPageCount(int). The page will be created with all the
options registered for that page index. Therefore, make all the calls to
addOption() before calling this method.
Parameters:
pageIndex - a zero-based index of the page relative to this template. Forexample, if a template need to have two pages, you have tocall this method twice (once with index 0 and again with index1).
Parameters:
helpContextId - the Id of the help context defined in the contributing plug-inthat will be used to locate content of the info-pop displayedwhen F1 is pressed.
See Also: OptionTemplateSection.setPageCount(int)
See Also: BaseOptionTemplateSection.addOption |
| flagMissingRequiredOption | | protected void flagMissingRequiredOption(TemplateOption option)(Code) | | Locates the page that this option is presented in and flags that the
option is required and is currently not set. The flagging is done by
setting the page incomplete and setting the error message that uses
option's message label.
Parameters:
option - the option that is required and currently not set |
| getDescription | | public String getDescription()(Code) | | Returns the description of this template to be used in the UI. The
description is obtained by creating a lookup key using the following
rule: "template.[section-id].desc". This key is used to locate the label
in the plugin.properties file of the plug-in that contributed this
template.
the translated description of this template |
| getInstallURL | | abstract protected URL getInstallURL()(Code) | | Returns the install URL of the plug-in that contributes this template.
the install URL of the contributing plug-in |
| getLabel | | public String getLabel()(Code) | | Returns the label of this template to be used in the UI. The label is
obtained by creating a lookup key using the following rule:
"template.[section-id].name". This key is used to locate the label in the
plugin.properties file of the plug-in that contributed this template.
the translated label of this template |
| getOptions | | public TemplateOption[] getOptions(int pageIndex)(Code) | | Returns options that belong to the page with the given index.
Parameters:
pageIndex - 0-based index of the template page @see #setPageCount(int) |
| getOptions | | public TemplateOption[] getOptions(WizardPage page)(Code) | | Returns options that are added to the provided wizard page.
Parameters:
page - wizard page that hosts required options array of options added to the provided wizard page |
| getPage | | public WizardPage getPage(int pageIndex)(Code) | | Returns the wizard page at the specified index. Pages must be created
prior to calling this method.
the wizard page at the specified index or null ifinvalid index.
See Also: OptionTemplateSection.createPage(int) |
| getPageIndex | | public int getPageIndex(TemplateOption option)(Code) | | Returns the zero-based index of a page that hosts the the given option.
Parameters:
option - template option for which a page index is being requested zero-based index of a page that hosts the option or -1 if none ofthe pages contain the option. |
| getTemplateDirectory | | protected String getTemplateDirectory()(Code) | | Returns the directory where all the templates are located in the
contributing plug-in.
"templates_[schemaVersion]" for code since Eclipse 3.0, or"templates" for pre-3.0 code. |
| getTemplateLocation | | public URL getTemplateLocation()(Code) | | Implements the abstract method by looking for templates using the
following path:
[install location]/[templateDirectory]/[sectionId]
the URL of the location where files to be emitted by thistemplate are located. |
| resetPageState | | protected void resetPageState()(Code) | | Resets the current page state by clearing the error message and making
the page complete, thereby allowing users to flip to the next page.
|
| setPageCount | | public void setPageCount(int count)(Code) | | Sets the number of pages this template will manage. This method must be
called prior to adding pages and options in order to initialize the
template. Once the method has been called, you can call methods that
accept page index in the range [0..count-1].
Parameters:
count - number of pages that this template will contribute to thetemplate wizard |
| validateOptions | | public void validateOptions(TemplateOption source)(Code) | | Validate options given a template option
|
| Methods inherited from org.eclipse.pde.ui.templates.BaseOptionTemplateSection | protected TemplateOption addBlankField(int pageIndex)(Code)(Java Doc)
protected TemplateOption addBlankField(int height, int pageIndex)(Code)(Java Doc)
protected ComboChoiceOption addComboChoiceOption(String name, String label, String[][] choices, String value, int pageIndex)(Code)(Java Doc)
protected TemplateOption addOption(String name, String label, boolean value, int pageIndex)(Code)(Java Doc)
protected TemplateOption addOption(String name, String label, String value, int pageIndex)(Code)(Java Doc)
protected TemplateOption addOption(String name, String label, String[][] choices, String value, int pageIndex)(Code)(Java Doc)
public void execute(IProject project, IPluginModelBase model, IProgressMonitor monitor) throws CoreException(Code)(Java Doc)
public boolean getBooleanOption(String key)(Code)(Java Doc)
public String getReplacementString(String fileName, String key)(Code)(Java Doc)
public String getStringOption(String name)(Code)(Java Doc)
public Object getValue(String name)(Code)(Java Doc)
protected void initializeFields(IFieldData data)(Code)(Java Doc)
public void initializeFields(IPluginModelBase model)(Code)(Java Doc)
protected void initializeOption(String name, Object value)(Code)(Java Doc)
public boolean isDependentOnParentWizard()(Code)(Java Doc)
protected void registerOption(TemplateOption option, Object value, int pageIndex)(Code)(Java Doc)
public void setOptionEnabled(String name, boolean enabled)(Code)(Java Doc)
abstract public void validateOptions(TemplateOption changed)(Code)(Java Doc)
|
|
|