oracle.bali.ewt.wizard
Class WelcomeWizardPage
java.lang.Object
|
+--oracle.bali.ewt.wizard.WizardPage
|
+--oracle.bali.ewt.wizard.ImageWizardPage
|
+--oracle.bali.ewt.wizard.TitledWizardPage
|
+--oracle.bali.ewt.wizard.WelcomeWizardPage
- public class WelcomeWizardPage
- extends TitledWizardPage
WelcomeWizardPage is a TitleWizardPage subclass that conforms to the Oracle
Wizard UI Spec section 4.1 on welcome pages. This is based on version 3.0
of the Oracle Wizards User Interface Specification.
A WelcomeWizardPage consists of a title that is in a larger font
at the top of the page with a description in the middle of the page
and a check box that lets the user decide if the welcome page should
be displayed the next time the wizard is invoked.
After each invocation of the wizard clients should store the
return value of isShowNextTime(). If isShowNextTime() is false clients
should start the wizard on the second page and not the welcome page. The
welcome page should not be disabled or removed.
Also the state of isShowNextTime() should be stored during runs of an
application. JEWT cannot provide a persistence mechanism so it is up to
clients to store that information in their applications persistent state.
Clients can listen for changes to the showNextTime property by adding
a PropertyChangeListener to the WizardPage and listen for PROPERTY_SHOW_NEXT_TIME
PropertyChangeEvents.
Field Summary |
static java.lang.String |
PROPERTY_SHOW_NEXT_TIME
The property to listen for when the showNextTime property changes. |
Constructor Summary |
WelcomeWizardPage(java.awt.Image image,
java.lang.String title,
java.lang.String description)
Construct a wizard welcome page with the given image, title, and
description. |
Method Summary |
java.lang.String |
getAccessibleDescription()
If setAccessibleDescription() has not been called
than simply return getTitle(). |
java.lang.String |
getDescription()
Get the description for the welcome page |
boolean |
isShowNextTime()
Get if the welcome page should be displayed the next time
the wizard is invoked. |
void |
setDescription(java.lang.String description)
Set the description for the welcome page |
void |
setShowNextTime(boolean showNextTime)
Set if the welcome page should be displayed the next time the wizard is
invoked. |
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 |
PROPERTY_SHOW_NEXT_TIME
public static final java.lang.String PROPERTY_SHOW_NEXT_TIME
- The property to listen for when the showNextTime property changes.
WelcomeWizardPage
public WelcomeWizardPage(java.awt.Image image,
java.lang.String title,
java.lang.String description)
- Construct a wizard welcome page with the given image, title, and
description.
isShowNextTime
public boolean isShowNextTime()
- Get if the welcome page should be displayed the next time
the wizard is invoked. If the user has decided that the welcome
page should not be displayed than the next time the wizard is displayed
the wizard should start from the first page after the welcome page.
The welcome page should not be hidden or disabled. It is the responsibility
of the client to persist the value of isShowNextTime().
setShowNextTime
public void setShowNextTime(boolean showNextTime)
- Set if the welcome page should be displayed the next time the wizard is
invoked. If the user has decided that the welcome page should not be
displayed, than the next time the wizard is displayed the wizard should
start from the first page after the welcome page. The welcome page should
not be hidden or disabled. It is the responsibility
of the client to persist the value of isShowNextTime().
getDescription
public java.lang.String getDescription()
- Get the description for the welcome page
setDescription
public void setDescription(java.lang.String description)
- Set the description for the welcome page
getAccessibleDescription
public java.lang.String getAccessibleDescription()
- If setAccessibleDescription() has not been called
than simply return getTitle().
- Overrides:
getAccessibleDescription
in class TitledWizardPage
- Following copied from class:
oracle.bali.ewt.wizard.WizardPage
- See Also:
WizardPage.setAccessibleDescription(java.lang.String)