|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.0.0) E17493-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.ide.wizard.GenericWizardLauncher
public class GenericWizardLauncher
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 |
---|
public static final java.awt.Color[] WIZARD_HEADER_GRADIENT
public static final java.lang.String CONTEXT_KEY
public static final java.lang.String WIZARD_NAME_KEY
Constructor Detail |
---|
public GenericWizardLauncher(Context initContext)
initContext
- the initial context under which the generic wizard
is being invoked.public GenericWizardLauncher(Context initContext, java.lang.String wizardTitle)
Method Detail |
---|
public final Namespace getNamespace()
public void setWizardTitle(java.lang.String title)
title
- to display for the wizardpublic java.lang.String getWizardTitle()
public void setGradientColors(java.awt.Color[] gradientColors)
gradientColors
- the colors for the header gradient.public java.awt.Color[] getGradientColors()
public void setWizardImage(java.awt.Image image)
image
- to display for the wizardpublic java.awt.Image getWizardImage()
public boolean addWelcomePage(java.lang.String welcomePageClassStr, java.lang.String helpID, java.lang.String pageTitle)
public void addWelcomePage(java.lang.String welcomeText, java.lang.String descriptiveText, java.lang.String saveKey, java.lang.String helpId)
public void addFinishPage(java.lang.String helpId)
helpId
- the help id to use for the Finish pagepublic void addFinishPage(java.lang.String finishText, java.lang.String descText, java.lang.String title, java.lang.String helpId)
finishText
- a summary of the changes that were made in the wizarddescText
- a description of the changes that were made in the
process of completing the wizard, and what will happen when the wizard
is dismissedtitle
- the page titlehelpId
- the help id to use for the Finish page@Deprecated public boolean addFinishPage(java.lang.String finishPageClassStr, java.lang.String helpID, java.lang.String pageTitle)
finishPageClassStr
- the fully qualified classname of the
Traversable
instance 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
public boolean addFinishPage(MetaClass finishPageMetaClass, java.lang.String helpID, java.lang.String pageTitle)
finishPageMetaClass
- the MetaClass for the
Traversable
instance 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
@Deprecated public boolean addPage(java.lang.String pageClass)
pageClass
- the fully qualified classname of the Traversable
instance that represents
the page.@Deprecated public boolean addPage(java.lang.String pageClass, java.lang.String helpID)
pageClass
- the fully qualified classname of 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)
public boolean addPage(MetaClass pageMetaClass, java.lang.String helpID)
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)
@Deprecated public boolean addPage(java.lang.String pageClassStr, java.lang.String helpID, java.lang.String pageTitle)
pageClassStr
- the fully qualified classname of 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
public boolean addPage(MetaClass pageMetaClass, java.lang.String helpID, java.lang.String pageTitle)
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
public void addPage(Step step)
step
- the step to add to the end of the listpublic void addPages(Step[] steps)
steps
- the steps to add to the end of the listpublic boolean runGenericWizard()
public boolean getShowStepNumber()
public void setShowStepNumber(boolean showStepNumber)
showStepNumber
- true if the wizard should show step numbers in
the title; false otherwise.public void addCommitListener(CommitListener commitListener)
CommitNotifier
CommitListener
that will be called when the
user applies or cancels changes.
addCommitListener
in interface CommitNotifier
public void removeCommitListener(CommitListener commitListener)
CommitNotifier
CommitListener
so that it
no longer receives notification when the user applies or cancels
changes.
removeCommitListener
in interface CommitNotifier
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.0.0) E17493-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |