Extension SDK

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 "Skip this Page Next Time" option in the IDE settings.

See Also:
WelcomeWizardPage

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 saveKey)
          Deprecated. use isWelcomeShown instead
static void _setWelcomeShown(boolean b, java.lang.String saveKey)
          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.
 boolean isShowNextTime()
          Deprecated. Use isSkipNextTime() instead.
 boolean isSkipNextTime()
          Indicates whether or not the Welcome page should be hidden the next time this wizard is invoked.
static boolean isWelcomeShown(java.lang.String saveKey)
          Deprecated. Use isWelcomeSkipped(String) instead.
static boolean isWelcomeSkipped(java.lang.String saveKey)
          Determine whether the user has requested that this page should be skipped the next time this wizard is run.
 void setHelpID(java.lang.String helpID)
          Set the helpId for the welcome panel.
 void setShowNextTime(boolean showNextTime)
          Deprecated. Use setSkipNextTime(boolean) instead.
 void setSkipNextTime(boolean skip)
          Specifies whether or not the Welcome page is skipped the next time the wizard is invoked.
static void setWelcomeShown(boolean b, java.lang.String saveKey)
          Deprecated. Use setWelcomeSkipped instead.
static void setWelcomeSkipped(boolean b, java.lang.String saveKey)
          Persists the setting for whether or not this Welcome page is skipped on subsequent runs.
 
Methods inherited from class oracle.bali.ewt.wizard.WelcomeWizardPage
getAccessibleDescription, getDescription, setDescription
 
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, addWizardValidateListener, firePropertyChange, getCanAdvance, getCanGoBack, getContent, getIndex, getInitialFocus, getLabel, getParent, isEnabled, isSelected, isVisible, processWizardValidateEvent, removePropertyChangeListener, removeWizardValidateListener, setAccessibleDescription, setCanAdvance, setCanGoBack, setContent, setEnabled, setInitialFocus, setLabel, 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 "Skip 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. This is currently an oracle.ide.wizard.ImageWizardPage.

isSkipNextTime

public boolean isSkipNextTime()
Indicates whether or not the Welcome page should be hidden the next time this wizard is invoked.
Overrides:
isSkipNextTime in class oracle.bali.ewt.wizard.WelcomeWizardPage
Returns:
true if the Welcome page should be hidden, false otherwise.

setSkipNextTime

public void setSkipNextTime(boolean skip)
Specifies whether or not the Welcome page is skipped the next time the wizard is invoked.
Overrides:
setSkipNextTime in class oracle.bali.ewt.wizard.WelcomeWizardPage
Parameters:
skip - true if the page should be skipped, false otherwise.

isShowNextTime

public boolean isShowNextTime()
Deprecated. Use isSkipNextTime() instead.

Overrides:
isShowNextTime in class oracle.bali.ewt.wizard.WelcomeWizardPage

setShowNextTime

public void setShowNextTime(boolean showNextTime)
Deprecated. Use setSkipNextTime(boolean) instead.

Overrides:
setShowNextTime in class oracle.bali.ewt.wizard.WelcomeWizardPage

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(int) 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.
See Also:
BaseWizard.setCurrentPageIndex(int)

_setWelcomeShown

public static void _setWelcomeShown(boolean b,
                                    java.lang.String saveKey)
Deprecated. Use setWelcomeShown instead.


setWelcomeShown

public static void setWelcomeShown(boolean b,
                                   java.lang.String saveKey)
Deprecated. Use setWelcomeSkipped instead.


setWelcomeSkipped

public static void setWelcomeSkipped(boolean b,
                                     java.lang.String saveKey)
Persists the setting for whether or not this Welcome page is skipped on subsequent runs.
Parameters:
b - this value should be true if you want to skip this page next time, false otherwise.
saveKey - the string to use when saving this value (persistence)

_isWelcomeShown

public static boolean _isWelcomeShown(java.lang.String saveKey)
Deprecated. use isWelcomeShown instead


isWelcomeShown

public static boolean isWelcomeShown(java.lang.String saveKey)
Deprecated. Use isWelcomeSkipped(String) instead.


isWelcomeSkipped

public static boolean isWelcomeSkipped(java.lang.String saveKey)
Determine whether the user has requested that this page should be skipped the next time this wizard is run.
Parameters:
savekey - String to be used when saving the value (persistence)
Returns:
true if the user wants to skip this page. This returns false if the user has never toggled the setting.

setHelpID

public void setHelpID(java.lang.String helpID)
Set the helpId for the welcome panel.

Extension SDK