Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.1.0)

E17493-02

oracle.ide.wizard
Class GenericWizardLauncher

java.lang.Object
  extended by oracle.ide.wizard.GenericWizardLauncher
All Implemented Interfaces:
CommitNotifier

public class GenericWizardLauncher
extends java.lang.Object
implements CommitNotifier

Since:
release specific (what release of product did this appear in)

Field Summary
static java.lang.String CONTEXT_KEY
           
static java.awt.Color[] WIZARD_HEADER_GRADIENT
           
static java.lang.String WIZARD_NAME_KEY
           
 
Constructor Summary
GenericWizardLauncher(Context initContext)
          Creates a new GenericWizardLauncher based on an existing context.
GenericWizardLauncher(Context initContext, java.lang.String wizardTitle)
           
 
Method Summary
 void addCommitListener(CommitListener commitListener)
          Adds an CommitListener that will be called when the user applies or cancels changes.
 boolean addFinishPage(MetaClass finishPageMetaClass, java.lang.String helpID, java.lang.String pageTitle)
          Adds a finish page to the wizard.
 void addFinishPage(java.lang.String helpId)
          Adds a sumary page to the wizard.
 boolean addFinishPage(java.lang.String finishPageClassStr, java.lang.String helpID, java.lang.String pageTitle)
          Deprecated. since 11.1.2.0.0 use variant that takes MetaClass instead
 void addFinishPage(java.lang.String finishText, java.lang.String descText, java.lang.String title, java.lang.String helpId)
          Adds a sumary page to the wizard.
 boolean addPage(MetaClass pageMetaClass, java.lang.String helpID)
          Adds a page to the wizard.
 boolean addPage(MetaClass pageMetaClass, java.lang.String helpID, java.lang.String pageTitle)
          Adds a page to the wizard.
 void addPage(Step step)
          Adds the given step to the list of steps for the pages of the wizard.
 boolean addPage(java.lang.String pageClass)
          Deprecated. since 11.1.2.0.0 use the variant that takes a MetaClass instead
 boolean addPage(java.lang.String pageClass, java.lang.String helpID)
          Deprecated. since 11.1.2.0.0 use the variant that takes a MetaClass instead
 boolean addPage(java.lang.String pageClassStr, java.lang.String helpID, java.lang.String pageTitle)
          Deprecated. since 11.1.2.0.0 use the variant that takes a MetaClass instead
 void addPages(Step[] steps)
          Adds the given steps to the list of steps for the pages of the wizard.
 boolean addWelcomePage(java.lang.String welcomePageClassStr, java.lang.String helpID, java.lang.String pageTitle)
          Deprecated. No replacment. This method is a no-op as welcome pages should not be shown in wizards any longer (since 11.0).
 void addWelcomePage(java.lang.String welcomeText, java.lang.String descriptiveText, java.lang.String saveKey, java.lang.String helpId)
          Deprecated. No replacment. This method is a no-op as welcome pages should not be shown in wizards any longer (since 11.0).
 java.awt.Color[] getGradientColors()
          Gets the color array to uwe when painting the gradient in the wizard.
 Namespace getNamespace()
           
 boolean getShowStepNumber()
          Gets whether or not the wizard should show the step numbers in the title.
 java.awt.Image getWizardImage()
          Gets the image specified for the wizard.
 java.lang.String getWizardTitle()
          Gets the title specified for the wizard.
 void removeCommitListener(CommitListener commitListener)
          Removes a previously added CommitListener so that it no longer receives notification when the user applies or cancels changes.
 boolean runGenericWizard()
          Runs the Generic Wizard based on the pages provided.
 void setGradientColors(java.awt.Color[] gradientColors)
          Sets the color array to use when painting the gradient in the wizard.
 void setShowStepNumber(boolean showStepNumber)
          Sets whether or not the wizard should show step numbers in the title.
 void setWizardImage(java.awt.Image image)
          Sets the image to display for the wizard.
 void setWizardTitle(java.lang.String title)
          Sets the title to display for the wizard.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WIZARD_HEADER_GRADIENT

public static final java.awt.Color[] WIZARD_HEADER_GRADIENT

CONTEXT_KEY

public static final java.lang.String CONTEXT_KEY
See Also:
Constant Field Values

WIZARD_NAME_KEY

public static final java.lang.String WIZARD_NAME_KEY
See Also:
Constant Field Values
Constructor Detail

GenericWizardLauncher

public GenericWizardLauncher(Context initContext)
Creates a new GenericWizardLauncher based on an existing context.

Parameters:
initContext - the initial context under which the generic wizard is being invoked.

GenericWizardLauncher

public GenericWizardLauncher(Context initContext,
                             java.lang.String wizardTitle)
Method Detail

getNamespace

public final Namespace getNamespace()

setWizardTitle

public void setWizardTitle(java.lang.String title)
Sets the title to display for the wizard.

Parameters:
title - to display for the wizard

getWizardTitle

public java.lang.String getWizardTitle()
Gets the title specified for the wizard.

Returns:
the title of the wizard

setGradientColors

public void setGradientColors(java.awt.Color[] gradientColors)
Sets the color array to use when painting the gradient in the wizard.

Parameters:
gradientColors - the colors for the header gradient.

getGradientColors

public java.awt.Color[] getGradientColors()
Gets the color array to uwe when painting the gradient in the wizard. Will return a default color array if not otherwise set

Returns:
color array to use for the gradient in the wizard

setWizardImage

public void setWizardImage(java.awt.Image image)
Sets the image to display for the wizard.

Parameters:
image - to display for the wizard

getWizardImage

public java.awt.Image getWizardImage()
Gets the image specified for the wizard.

Returns:
the image of the wizard

addWelcomePage

public boolean addWelcomePage(java.lang.String welcomePageClassStr,
                              java.lang.String helpID,
                              java.lang.String pageTitle)
Deprecated. No replacment. This method is a no-op as welcome pages should not be shown in wizards any longer (since 11.0).


addWelcomePage

public void addWelcomePage(java.lang.String welcomeText,
                           java.lang.String descriptiveText,
                           java.lang.String saveKey,
                           java.lang.String helpId)
Deprecated. No replacment. This method is a no-op as welcome pages should not be shown in wizards any longer (since 11.0).


addFinishPage

public void addFinishPage(java.lang.String helpId)
Adds a sumary page to the wizard. For most wizards a Finish page is not necessary and should be exluded; a Finish page should only be used for wizards that do multiple complex operations.

Parameters:
helpId - the help id to use for the Finish page

addFinishPage

public void addFinishPage(java.lang.String finishText,
                          java.lang.String descText,
                          java.lang.String title,
                          java.lang.String helpId)
Adds a sumary page to the wizard. For most wizards a Finish page is not necessary and should be exluded; a Finish page should only be used for wizards that do multiple complex operations.

Parameters:
finishText - a summary of the changes that were made in the wizard
descText - a description of the changes that were made in the process of completing the wizard, and what will happen when the wizard is dismissed
title - the page title
helpId - the help id to use for the Finish page

addFinishPage

@Deprecated
public boolean addFinishPage(java.lang.String finishPageClassStr,
                                        java.lang.String helpID,
                                        java.lang.String pageTitle)
Deprecated. since 11.1.2.0.0 use variant that takes MetaClass instead

Adds a finish page to the wizard. This method should be used when you want to create a custom finish page.

Parameters:
finishPageClassStr - the fully qualified classname of the Traversableinstance that represents the welcome page.
helpID - the helpID for the page. The helpid set here allows the code that is creating the wizard to override the helpid set by the panel used in the page (necessary as the help text usually is written within the context of the wizard that is displaying the panel)
pageTitle - displayed for this page of the wizard
Returns:
true if the page was added

addFinishPage

public boolean addFinishPage(MetaClass finishPageMetaClass,
                             java.lang.String helpID,
                             java.lang.String pageTitle)
Adds a finish page to the wizard. This method should be used when you want to create a custom finish page.

Parameters:
finishPageMetaClass - the MetaClass for the Traversableinstance that represents the welcome page.
helpID - the helpID for the page. The helpid set here allows the code that is creating the wizard to override the helpid set by the panel used in the page (necessary as the help text usually is written within the context of the wizard that is displaying the panel)
pageTitle - displayed for this page of the wizard
Returns:
true if the page was added

addPage

@Deprecated
public boolean addPage(java.lang.String pageClass)
Deprecated. since 11.1.2.0.0 use the variant that takes a MetaClass instead

Adds a page to the wizard.

Parameters:
pageClass - the fully qualified classname of the Traversable instance that represents the page.

addPage

@Deprecated
public boolean addPage(java.lang.String pageClass,
                                  java.lang.String helpID)
Deprecated. since 11.1.2.0.0 use the variant that takes a MetaClass instead

Adds a page to the wizard. This method attempts to use the getTitle method on the pageClass to get the title of the page, but will succeed even if the pageClass does not have that method defined.

Parameters:
pageClass - the fully qualified classname of the Traversableinstance that represents the page.
helpID - the helpID for the page. The helpid set here allows the code that is creating the wizard to override the helpid set by the panel used in the page (necessary as the help text usually is written within the context of the wizard that is displaying the panel)
Returns:
true if the page was added

addPage

public boolean addPage(MetaClass pageMetaClass,
                       java.lang.String helpID)
Adds a page to the wizard. This method attempts to use the getTitle method on the pageClass to get the title of the page, but will succeed even if the pageClass does not have that method defined.

Parameters:
pageMetaClass - the MetaClass for the Traversableinstance that represents the page.
helpID - the helpID for the page. The helpid set here allows the code that is creating the wizard to override the helpid set by the panel used in the page (necessary as the help text usually is written within the context of the wizard that is displaying the panel)
Returns:
true if the page was added

addPage

@Deprecated
public boolean addPage(java.lang.String pageClassStr,
                                  java.lang.String helpID,
                                  java.lang.String pageTitle)
Deprecated. since 11.1.2.0.0 use the variant that takes a MetaClass instead

Adds a page to the wizard. This method is useful when the pageClass either does not implement getTitle() or you want to override the name of a page for the specific wizard being created.

Parameters:
pageClassStr - the fully qualified classname of the Traversableinstance that represents the page.
helpID - the helpID for the page. The helpid set here allows the code that is creating the wizard to override the helpid set by the panel used in the page (necessary as the help text usually is written within the context of the wizard that is displaying the panel)
pageTitle - displayed for this page of the wizard
Returns:
true if the page was added

addPage

public boolean addPage(MetaClass pageMetaClass,
                       java.lang.String helpID,
                       java.lang.String pageTitle)
Adds a page to the wizard. This method is useful when the pageClass either does not implement getTitle() or you want to override the name of a page for the specific wizard being created.

Parameters:
pageMetaClass - the MetaClass for the Traversable instance that represents the page.
helpID - the helpID for the page. The helpid set here allows the code that is creating the wizard to override the helpid set by the panel used in the page (necessary as the help text usually is written within the context of the wizard that is displaying the panel)
pageTitle - displayed for this page of the wizard
Returns:
true if the page was added

addPage

public void addPage(Step step)
Adds the given step to the list of steps for the pages of the wizard.

Parameters:
step - the step to add to the end of the list

addPages

public void addPages(Step[] steps)
Adds the given steps to the list of steps for the pages of the wizard.

Parameters:
steps - the steps to add to the end of the list

runGenericWizard

public boolean runGenericWizard()
Runs the Generic Wizard based on the pages provided.

Returns:
true if the wizard was accepted, false otherwise.

getShowStepNumber

public boolean getShowStepNumber()
Gets whether or not the wizard should show the step numbers in the title.

Returns:
true if the wizard has been asked to display step numbers; false otherwise.

setShowStepNumber

public void setShowStepNumber(boolean showStepNumber)
Sets whether or not the wizard should show step numbers in the title.

Parameters:
showStepNumber - true if the wizard should show step numbers in the title; false otherwise.

addCommitListener

public void addCommitListener(CommitListener commitListener)
Description copied from interface: CommitNotifier
Adds an CommitListener that will be called when the user applies or cancels changes.

Specified by:
addCommitListener in interface CommitNotifier

removeCommitListener

public void removeCommitListener(CommitListener commitListener)
Description copied from interface: CommitNotifier
Removes a previously added CommitListener so that it no longer receives notification when the user applies or cancels changes.

Specified by:
removeCommitListener in interface CommitNotifier

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.1.0)

E17493-02

Copyright © 1997, 2011, Oracle. All rights reserved.