com.ibm.xtools.common.ui.wizards

Class NewModelFromTemplatePage

java.lang.Object

org.eclipse.jface.dialogs.DialogPage

org.eclipse.jface.wizard.WizardPage

com.ibm.xtools.common.ui.wizards.AbstractNewModelPage

com.ibm.xtools.common.ui.wizards.NewModelFromTemplatePage

All Implemented Interfaces:

org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.wizard.IWizardPage

public class NewModelFromTemplatePage
extends AbstractNewModelPage

A new model wizard page which creates a new model from a standard template.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	NewModelFromTemplatePage.MergedCategory Group of categories with the same label and parent.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<ITemplate,TemplateConfiguration>	configsCache Template configuration cache
protected java.util.Map<ITemplate,TemplateConfigurationPageGroupNavigator>	groupNavigatorCache Template configuration page group navigator cache
protected static java.lang.String	LAST_CATEGORY
protected static java.lang.String	LAST_TEMPLATE

Fields inherited from class com.ibm.xtools.common.ui.wizards.AbstractNewModelPage

browseButton, containerControl, DESCRIPTION_MINIMUM_WIDTH, fileNameControl, helpID, IMAGE_MAX_HEIGHT, IMAGE_MAX_WIDTH, resourceContainer, selection

Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

Constructors

Constructor and Description
NewModelFromTemplatePage(java.lang.String pageName, org.eclipse.jface.viewers.IStructuredSelection selection) Constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	allowUseOfTemplate(ITemplate template) Return whether the use of the given template is allowed.
boolean	canFlipToNextPage()
void	createControl(org.eclipse.swt.widgets.Composite parent) Creates the controls including buttons tree and table controls that appear in the dialog box.
protected TemplateConfigurationPageGroupNavigator	createGroupNavigator(java.lang.String templateId) Create corresponding template configuration page group navigator for given template id.
protected boolean	finishPage(org.eclipse.core.runtime.IProgressMonitor monitor)
protected java.lang.String	getInitialCategorySelectionID() Get the category ID to be selected.
protected java.lang.String	getInitialTemplateSelectionID() Get the template ID to be selected.
protected java.lang.String	getModelFileExtension() Lazily instantiates the EXTENSION field to avoid premature plugin loading.
protected com.ibm.xtools.common.ui.wizards.internal.NewModelWizardRegistry	getNewModelWizardRegistry() Returns NewModelWizardRegistry
org.eclipse.jface.wizard.IWizardPage	getNextPage()
protected ITemplate	getSelectedTemplate() Return the selected template.
protected TemplateConfiguration	getTemplateConfiguration() Return the template configuration for the selected template.
TemplateConfigurationPageGroupNavigator	getTemplateConfigurationPageGroupNavigator() Return the template configuration page group navigator for the selected template.
protected void	initCategoriesViewer(org.eclipse.jface.viewers.TreeViewer categories) Initializes the categories tree viewer.
protected void	initTemplatesViewer(org.eclipse.jface.viewers.TableViewer templates) Initializes the templates table viewer.
protected boolean	isCategoryDisplayable(ICategory category) Return true if the category should be displayed in the categories viewer, false otherwise.
protected boolean	isTemplateDisplayable(ITemplate template) Return true if the template should be displayed in the templates viewer, false otherwise.
protected boolean	preFinishPage()
protected void	readPageSettings() Read the wizard page settings for the default category and template.
protected void	savePageSettings() Save the wizard page settings for the default category and template.
protected boolean	validatePage() A page is considered validated if both the filename and container are OK.
protected boolean	validateTemplate() Validate the selected template.

Methods inherited from class com.ibm.xtools.common.ui.wizards.AbstractNewModelPage

createContainerControlGroup, createFileNameLabel, createProject, getContainerPath, getContainerText, getContainingProjectName, getDefaultDirectoryName, getFileName, handleBrowse, initialPopulateContainerNameField, isProjectWizard, makeAndAppendFilename, makeFilename, removeProject, setHelpID, setVisible, updateContainer, validateContainer, validateFilename

Methods inherited from class org.eclipse.jface.wizard.WizardPage

getContainer, getDialogSettings, getImage, getName, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString

Methods inherited from class org.eclipse.jface.dialogs.DialogPage

convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage

dispose, getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp

Field Detail

LAST_CATEGORY

protected static final java.lang.String LAST_CATEGORY

See Also:

Constant Field Values

LAST_TEMPLATE

protected static final java.lang.String LAST_TEMPLATE

See Also:

Constant Field Values

configsCache

protected java.util.Map<ITemplate,TemplateConfiguration> configsCache

Template configuration cache

groupNavigatorCache

protected final java.util.Map<ITemplate,TemplateConfigurationPageGroupNavigator> groupNavigatorCache

Template configuration page group navigator cache

Constructor Detail

NewModelFromTemplatePage

public NewModelFromTemplatePage(java.lang.String pageName,
                                org.eclipse.jface.viewers.IStructuredSelection selection)

Constructor.

Parameters:

pageName -

selection -

Method Detail

readPageSettings

protected void readPageSettings()

Read the wizard page settings for the default category and template.

savePageSettings

protected void savePageSettings()

Save the wizard page settings for the default category and template.

createControl

public void createControl(org.eclipse.swt.widgets.Composite parent)

Creates the controls including buttons tree and table controls that appear in the dialog box.

Specified by:

createControl in interface org.eclipse.jface.dialogs.IDialogPage

Overrides:

createControl in class AbstractNewModelPage

Parameters:

parent - the parent composite to be treated as the controls' parent

getNewModelWizardRegistry

protected com.ibm.xtools.common.ui.wizards.internal.NewModelWizardRegistry getNewModelWizardRegistry()

Returns NewModelWizardRegistry

Returns:

NewModelWizardRegistry

initCategoriesViewer

protected void initCategoriesViewer(org.eclipse.jface.viewers.TreeViewer categories)

Initializes the categories tree viewer.

Parameters:

categories - the categories tree viewer

initTemplatesViewer

protected void initTemplatesViewer(org.eclipse.jface.viewers.TableViewer templates)

Initializes the templates table viewer.

Parameters:

templates - the templates table viewer

isCategoryDisplayable

protected boolean isCategoryDisplayable(ICategory category)

Return true if the category should be displayed in the categories viewer, false otherwise.

Parameters:

category - the category to display

Returns:

true if the category should be displayed in the categories viewer, false otherwise

isTemplateDisplayable

protected boolean isTemplateDisplayable(ITemplate template)

Return true if the template should be displayed in the templates viewer, false otherwise.

Parameters:

template - the template to display

Returns:

true if the template should be displayed in the templates viewer, false otherwise

getInitialCategorySelectionID

protected java.lang.String getInitialCategorySelectionID()

Get the category ID to be selected. Return null to select the first category.

Returns:

the category ID to be selected

getInitialTemplateSelectionID

protected java.lang.String getInitialTemplateSelectionID()

Get the template ID to be selected. Return null to select the first template.

Note: If the template is not found under the initial category, then the first template will be selected.

Returns:

the template ID to be selected

validateTemplate

protected boolean validateTemplate()

Validate the selected template.

Returns:

true if valid template selection

validatePage

protected boolean validatePage()

A page is considered validated if both the filename and container are OK. The function has been written in one line since the two functions in validatePage are not meant to be called one after the other if the first one fails.

Overrides:

validatePage in class AbstractNewModelPage

Returns:

true if validated, false if not.

getSelectedTemplate

protected ITemplate getSelectedTemplate()

Return the selected template.

Returns:

the selected template

getTemplateConfigurationPageGroupNavigator

public TemplateConfigurationPageGroupNavigator getTemplateConfigurationPageGroupNavigator()

Return the template configuration page group navigator for the selected template.

Returns:

the template configuration page group navigator for the selected template

createGroupNavigator

protected TemplateConfigurationPageGroupNavigator createGroupNavigator(java.lang.String templateId)

Create corresponding template configuration page group navigator for given template id.

Parameters:

templateId - given template id

Returns:

template configuration page group navigator

getTemplateConfiguration

protected TemplateConfiguration getTemplateConfiguration()

Return the template configuration for the selected template.

Returns:

the template configuration for the selected template

preFinishPage

protected boolean preFinishPage()

Overrides:

preFinishPage in class AbstractNewModelPage

finishPage

protected boolean finishPage(org.eclipse.core.runtime.IProgressMonitor monitor)

Overrides:

finishPage in class AbstractNewModelPage

getModelFileExtension

protected java.lang.String getModelFileExtension()

Description copied from class: AbstractNewModelPage

Lazily instantiates the EXTENSION field to avoid premature plugin loading.

Specified by:

getModelFileExtension in class AbstractNewModelPage

Returns:

the file extension for model files

canFlipToNextPage

public boolean canFlipToNextPage()

Specified by:

canFlipToNextPage in interface org.eclipse.jface.wizard.IWizardPage

Overrides:

canFlipToNextPage in class org.eclipse.jface.wizard.WizardPage

getNextPage

public org.eclipse.jface.wizard.IWizardPage getNextPage()

Specified by:

getNextPage in interface org.eclipse.jface.wizard.IWizardPage

Overrides:

getNextPage in class org.eclipse.jface.wizard.WizardPage

allowUseOfTemplate

protected boolean allowUseOfTemplate(ITemplate template)

Return whether the use of the given template is allowed.

If the given template is null return false.

Parameters:

template - the template in question

Returns:

true if the use of the given template is allowed, false otherwise