oracle.ide.wizard
Class WizardWelcomePage

java.lang.Object
  oracle.bali.ewt.wizard.WizardPage
      oracle.bali.ewt.wizard.ImageWizardPage
          oracle.bali.ewt.wizard.TitledWizardPage
              oracle.bali.ewt.wizard.WelcomeWizardPage
                  oracle.ide.wizard.WizardWelcomePage

public final class WizardWelcomePage
extends oracle.bali.ewt.wizard.WelcomeWizardPage

A subclass of oracle.bali.ewt.wizard.WelcomeWizardPage which provides support for persisting the "show this page next time" option in the IDE settings.

See Also:

WelcomeWizardPage

Field Summary

Fields inherited from class oracle.bali.ewt.wizard.WelcomeWizardPage

PROPERTY_SHOW_NEXT_TIME, PROPERTY_SKIP_NEXT_TIME

Fields inherited from class oracle.bali.ewt.wizard.WizardPage

NOT_ADDED_INDEX

Constructor Summary

WizardWelcomePage(java.awt.Image image, java.lang.String title, java.lang.String description)

WizardWelcomePage(java.lang.String id)
Construct a wizard welcome page.

Method Summary

static boolean	_isWelcomeShown(java.lang.String wizardID) Deprecated. use isWelcomeShown instead
static void	_setWelcomeShown(boolean b, java.lang.String wizardID) Deprecated. Use setWelcomeShown instead.
oracle.bali.ewt.wizard.ImageWizardPage	getWizardPage() Get the wizard page
boolean	isHidden() Find out if the welcome page has been hidden by the user.
static boolean	isWelcomeShown(java.lang.String wizardID) Determine whether the user has requested that this page not be shown on a previous run
void	setHelpID(java.lang.String helpID) Set the helpId for the welcome panel
static void	setWelcomeShown(boolean b, java.lang.String wizardID) Persistently set whether this welcome page is shown next time.

Methods inherited from class oracle.bali.ewt.wizard.WelcomeWizardPage

getAccessibleDescription, getDescription, isShowNextTime, isSkipNextTime, isVisible, setDescription, setShowNextTime, setSkipNextTime

Methods inherited from class oracle.bali.ewt.wizard.TitledWizardPage

getInteractiveArea, getTitle, setInteractiveArea, setTitle

Methods inherited from class oracle.bali.ewt.wizard.ImageWizardPage

getImage, setImage

Methods inherited from class oracle.bali.ewt.wizard.WizardPage

addPropertyChangeListener, addValidationComponent, addWizardValidateListener, firePropertyChange, getCanAdvance, getCanGoBack, getContent, getIndex, getInitialFocus, getLabel, getPageTitle, getParent, getValidationComponents, isBranching, isEnabled, isSelected, isValid, isVisited, processWizardValidateEvent, removeAllValidationComponents, removePropertyChangeListener, removeValidationComponent, removeWizardValidateListener, reset, setAccessibleDescription, setBranching, setCanAdvance, setCanGoBack, setContent, setEnabled, setInitialFocus, setLabel, setPageTitle, setValid, setVisible, toString, validatePage

Methods inherited from class java.lang.Object

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

Constructor Detail

WizardWelcomePage

public WizardWelcomePage(java.lang.String id)

Construct a wizard welcome page. You should pass in a unique id which will be used as part of the persistence of the "Show this page next time" checkbox.

Parameters:

id - a unique id. Must not be null

WizardWelcomePage

public WizardWelcomePage(java.awt.Image image,
                         java.lang.String title,
                         java.lang.String description)

Method Detail

getWizardPage

public oracle.bali.ewt.wizard.ImageWizardPage getWizardPage()

Get the wizard page

Returns:

an ImageWizardPage.

isHidden

public boolean isHidden()

Find out if the welcome page has been hidden by the user.

Returns:

true if the user has chosen to hide the welcome page. This is remembered from a previous invocation of the wizard. If this method returns true, you should use BaseWizard.setCurrentPageIndex(1) so that the welcome page is not displayed. Do NOT disable or remove the welcome page from the wizard in create mode under any circumstances.

_setWelcomeShown

public static void _setWelcomeShown(boolean b,
                                    java.lang.String wizardID)

Deprecated. Use setWelcomeShown instead.

setWelcomeShown

public static void setWelcomeShown(boolean b,
                                   java.lang.String wizardID)

Persistently set whether this welcome page is shown next time.

Parameters:

b - whether to show this welcome page next time

wizardID - string to use when saving this value (persistence)

_isWelcomeShown

public static boolean _isWelcomeShown(java.lang.String wizardID)

Deprecated. use isWelcomeShown instead

isWelcomeShown

public static boolean isWelcomeShown(java.lang.String wizardID)

Determine whether the user has requested that this page not be shown on a previous run

Parameters:

wizardID - String to be used when saving the value (persistence)

Returns:

true if the user wants to see this page. This returns true if the user has never toggled the setting

setHelpID

public void setHelpID(java.lang.String helpID)

Set the helpId for the welcome panel