oracle.jdeveloper.template.wizard
Class TemplateWizardUtil

java.lang.Object
  oracle.jdeveloper.template.wizard.TemplateWizardUtil

public abstract class TemplateWizardUtil
extends java.lang.Object

Helper class for storing and retrieving information from the shared TraversableContext used in the New Application and New Project wizards.

Constructor Summary

TemplateWizardUtil()

Method Summary

static Workspace	getApplication(TraversableContext wizardContext) Gets the new Workspace from the wizard TraversableContext - this is the workspace that was created as a result of finishing the wizard.
static TraversableContext	getApplicationData(TraversableContext wizardContext) Gets the TraversableContext containing the application-level data, which is shared between wizard project panels.
static java.lang.String	getApplicationPackage(TraversableContext wizardContext)
static ApplicationTemplate	getApplicationTemplate(TraversableContext wizardContext)
static java.net.URL	getApplicationURL(TraversableContext wizardContext) Gets the URL to use to create the new workspace.
static Context	getContext(TraversableContext wizardContext) Gets the Context from which the wizard was invoked.
static Project	getProject(TraversableContext wizardContext) Gets the new Project from the wizard TraversableContext - this is the project that was created as a result of finishing the wizard.
static ProjectTemplate	getProjectTemplate(TraversableContext wizardContext) Gets the ProjectTemplate from the wizard TraversableContext.
static TraversableContext[]	getProjectTraversableContexts(TraversableContext wizardContext) Gets the array of TraversableContexts used by the New Application Wizard.
static java.net.URL	getProjectURL(TraversableContext wizardContext) Gets the URL that will be used to create the project.
static TraversableContext	newContextForProjectPages(TraversableContext applicationData) Creates a new TraversableContext for use with project wizard pages.
static TraversableContext	newWizardContext(Context context) Creates a new TraversableContext for use with the New Application and New Project dynamic wizards.
static void	setApplication(Workspace newWorkspace, TraversableContext wizardContext) Stores the newly-created workspace in the wizard data cotext.
static void	setApplicationPackage(java.lang.String appPackage, TraversableContext wizardContext)
static void	setApplicationTemplate(ApplicationTemplate appTemplate, TraversableContext wizardContext)
static void	setApplicationURL(java.net.URL url, TraversableContext wizardContext) Sets the URL to use to create the new workspace.
static void	setProject(Project project, TraversableContext wizardContext) Stores the newly-created project in the wizard data cotext.
static void	setProjectTemplate(ProjectTemplate projTemplate, TraversableContext wizardContext) Sets the project template to use to configure the new projejct.
static void	setProjectTraversableContexts(TraversableContext[] contexts, TraversableContext wizardData)
static void	setProjectURL(java.net.URL url, TraversableContext wizardContext) Sets the URL to use to create the project.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateWizardUtil

public TemplateWizardUtil()

Method Detail

newWizardContext

public static TraversableContext newWizardContext(Context context)

Creates a new TraversableContext for use with the New Application and New Project dynamic wizards.

Parameters:

context - The context in which the wizard was invoked

Returns:

a TraversableContext

newContextForProjectPages

public static TraversableContext newContextForProjectPages(TraversableContext applicationData)

Creates a new TraversableContext for use with project wizard pages. The TraversableContext that contains the application data is stored in the new context and can be accessed using getApplicationData(oracle.ide.panels.TraversableContext).

getProjectTraversableContexts

public static TraversableContext[] getProjectTraversableContexts(TraversableContext wizardContext)

Gets the array of TraversableContexts used by the New Application Wizard. Each project template referenced in the application template appears as a page (or set of pages, depending on the selected technology scopes) in the wizard. Pages that pertain to a single project template share a single TraversableContext.

Parameters:

wizardContext - The TraversableContext used by the wizard

Returns:

setProjectTraversableContexts

public static void setProjectTraversableContexts(TraversableContext[] contexts,
                                                 TraversableContext wizardData)

getApplicationData

public static TraversableContext getApplicationData(TraversableContext wizardContext)

Gets the TraversableContext containing the application-level data, which is shared between wizard project panels.

Parameters:

wizardContext - The project-level wizard context

Returns:

a TraversableContext

See Also:

getProjectTraversableContexts(oracle.ide.panels.TraversableContext)

getContext

public static Context getContext(TraversableContext wizardContext)

Gets the Context from which the wizard was invoked.

Parameters:

wizardContext - The wizard data context

Returns:

The active context

getProject

public static Project getProject(TraversableContext wizardContext)

Gets the new Project from the wizard TraversableContext - this is the project that was created as a result of finishing the wizard. During the lifetime of the wizard, this method will return null.

Parameters:

wizardContext - The TraversableContext used by the wizard

Returns:

The project created by the wizard, or null if the wizard has not been finished

setProject

public static void setProject(Project project,
                              TraversableContext wizardContext)

Stores the newly-created project in the wizard data cotext.

Parameters:

project - A project

wizardContext - The TraversableContext used by the wizard

getProjectTemplate

public static ProjectTemplate getProjectTemplate(TraversableContext wizardContext)

Gets the ProjectTemplate from the wizard TraversableContext.

Parameters:

wizardContext - The TraversableContext used by the wizard

Returns:

The project template from which the new project will be created

setProjectTemplate

public static void setProjectTemplate(ProjectTemplate projTemplate,
                                      TraversableContext wizardContext)

Sets the project template to use to configure the new projejct.

Parameters:

projTemplate - A project template

wizardContext - The TraversableContext used by the wizard

getProjectURL

public static java.net.URL getProjectURL(TraversableContext wizardContext)

Gets the URL that will be used to create the project.

Parameters:

wizardContext - The TraversableContext used by the wizard

Returns:

a project URL, or null if the project URL has not been stored in the TraversableContext.

setProjectURL

public static void setProjectURL(java.net.URL url,
                                 TraversableContext wizardContext)

Sets the URL to use to create the project.

Parameters:

url - A project URL

wizardContext - The TraversableContext used by the wizard

getApplication

public static Workspace getApplication(TraversableContext wizardContext)

Gets the new Workspace from the wizard TraversableContext - this is the workspace that was created as a result of finishing the wizard. During the lifetime of the wizard, this method will return null.

Parameters:

wizardContext - The TraversableContext used by the wizard

Returns:

The workspace created by the wizard, or null if the wizard has not been finished

setApplication

public static void setApplication(Workspace newWorkspace,
                                  TraversableContext wizardContext)

Stores the newly-created workspace in the wizard data cotext.

Parameters:

newWorkspace - A Workspace

wizardContext - The TraversableContext used by the wizard

getApplicationTemplate

public static ApplicationTemplate getApplicationTemplate(TraversableContext wizardContext)

Parameters:

wizardContext - The TraversableContext used by the wizard

Returns:

setApplicationTemplate

public static void setApplicationTemplate(ApplicationTemplate appTemplate,
                                          TraversableContext wizardContext)

Parameters:

appTemplate -

wizardContext - The TraversableContext used by the wizard

getApplicationURL

public static java.net.URL getApplicationURL(TraversableContext wizardContext)

Gets the URL to use to create the new workspace.

Parameters:

wizardContext - The TraversableContext used by the wizard

Returns:

The workspace URL

setApplicationURL

public static void setApplicationURL(java.net.URL url,
                                     TraversableContext wizardContext)

Sets the URL to use to create the new workspace.

Parameters:

url - The URL of the application

wizardContext - The TraversableContext used by the wizard

getApplicationPackage

public static java.lang.String getApplicationPackage(TraversableContext wizardContext)

Parameters:

wizardContext - The TraversableContext used by the wizard

Returns:

setApplicationPackage

public static void setApplicationPackage(java.lang.String appPackage,
                                         TraversableContext wizardContext)

Parameters:

appPackage -

wizardContext - The TraversableContext used by the wizard