|
Oracle JEWT API Reference Release 4.2.24.0.0 B12199-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.bali.ewt.wizard.WizardPage
WizardPages hold the content of the wizard. They associate a panel with a unique label.
Context-sensitive Help
While WizardPages lack setHelpTopic()
and
setHelpBook()
methods, context-sensitive help
can be set on the content component in the wizard page.
Event summary:
WizardPages can deliver WizardPage.VALIDATE_PAGE events. The WizardEvent.VALIDATE_PAGE event supports the Cancelable interface. The event can be cancelled by calling the cancel() method of this interface; see the Wizard class documentation for more information on page validation.
BaseWizard
,
Wizard
,
ReentrantWizard
,
WizardValidateListener
,
Cancelable
Field Summary | |
static int |
NOT_ADDED_INDEX
Index returned for pages that haven't been added to a Wizard. |
Constructor Summary | |
WizardPage(java.awt.Component content)
Creates a wizard page with no label. |
|
WizardPage(java.awt.Component content,
java.lang.String label)
Creates a wizard page. |
Method Summary | |
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Add a PropertyChangeListener to the listener list. |
void |
addWizardValidateListener(WizardValidateListener listener)
Adds a listener for wizard validation events. |
protected void |
firePropertyChange(java.lang.String propertyName,
java.lang.Object oldValue,
java.lang.Object newValue)
Delivers a property change event to all registered listeners. |
java.lang.String |
getAccessibleDescription()
Get the accessibleDescription of the WizardPage. |
boolean |
getCanAdvance()
Checks whether the client is allowed to advance from this page. |
boolean |
getCanGoBack()
Checks whether the client is allowed to go backwards from this page. |
java.awt.Component |
getContent()
Retrieves the content associated with the page. |
int |
getIndex()
Returns the index of the WizardPage in the wizard. |
java.awt.Component |
getInitialFocus()
Returns the component that will receive focus initially. |
java.lang.String |
getLabel()
Retrieves the label associated with the page. |
BaseWizard |
getParent()
Returns the wizard to which this page currently belongs. |
boolean |
isEnabled()
Checks if the page is enabled. |
boolean |
isSelected()
Checks if the page is selected. |
boolean |
isVisible()
Checks if the page is visible. |
protected void |
processWizardValidateEvent(oracle.bali.ewt.wizard.WizardValidateEvent event)
Processes a WizardValidateEvent |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Remove a PropertyChangeListener from the listener list. |
void |
removeWizardValidateListener(WizardValidateListener listener)
Removes a listener for wizard validation events. |
void |
setAccessibleDescription(java.lang.String accessibleDescription)
Set the accessibleDescription of the WizardPage. |
void |
setCanAdvance(boolean advance)
Sets whether the client is allowed to advance from this page. |
void |
setCanGoBack(boolean canGoBack)
Sets whether the client is allowed to go backwards from this page. |
void |
setContent(java.awt.Component content)
Sets the content associated with the page. |
void |
setEnabled(boolean enabled)
Enables or disables the page. |
void |
setInitialFocus(java.awt.Component initialFocus)
Sets the component that will receive focus initially. |
void |
setLabel(java.lang.String label)
Sets the label associated with the page. |
void |
setVisible(boolean visible)
Hides or shows the wizard page. |
java.lang.String |
toString()
Returns a string representation of the page. |
protected boolean |
validatePage()
Sends a validate event, and checks whether any listener cancelled |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int NOT_ADDED_INDEX
Constructor Detail |
public WizardPage(java.awt.Component content)
content
- the component used for this page.public WizardPage(java.awt.Component content, java.lang.String label)
content
- the component used for this page.label
- the label on this page. The label
is only user-visible for ReentrantWizards.Method Detail |
public void setVisible(boolean visible)
visible
- true to show the page, false to hide it.public boolean isVisible()
public void setContent(java.awt.Component content)
content
- the new componentpublic java.awt.Component getContent()
public void setLabel(java.lang.String label)
label
- the new label. The label
is only user-visible if the Wizard is freely
navigable.public java.lang.String getLabel()
public void setEnabled(boolean enabled)
enabled
- true to enable the page, false to disable it.public boolean isEnabled()
public void setCanAdvance(boolean advance)
public boolean getCanAdvance()
public void setCanGoBack(boolean canGoBack)
public boolean getCanGoBack()
public boolean isSelected()
BaseWizard.selectPage(oracle.bali.ewt.wizard.WizardPage)
,
BaseWizard.getSelectedPage()
public int getIndex()
BaseWizard.getCurrentPageIndex()
public BaseWizard getParent()
public java.awt.Component getInitialFocus()
public void setInitialFocus(java.awt.Component initialFocus)
public java.lang.String getAccessibleDescription()
setAccessibleDescription(java.lang.String)
public void setAccessibleDescription(java.lang.String accessibleDescription)
getAccessibleDescription()
public void addWizardValidateListener(WizardValidateListener listener)
listener
- the listenerpublic void removeWizardValidateListener(WizardValidateListener listener)
listener
- the listenerpublic java.lang.String toString()
toString
in class java.lang.Object
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The PropertyChangeListener to be addedpublic void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The PropertyChangeListener to be removedprotected void firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
propertyName
- The property nameoldValue
- The old value of the propertynewValue
- The new value of the propertyprotected boolean validatePage()
protected void processWizardValidateEvent(oracle.bali.ewt.wizard.WizardValidateEvent event)
event
- the event
|
Oracle JEWT 4.2.24 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |