oracle.ide.wizard
Interface BasicWizardPage

public interface BasicWizardPage

BasicWizardPage is an interface that must be implemented by pages used by a BasicWizard implementation.

Field Summary

static java.lang.String

COMPLETE_PROPERTY JavaBeans property indicating whether this page is in a complete state (i.e.

Method Summary

void	addPropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener pcl) Add a property change listener
void	completeValueChanged() Subclasses call this when the complete property may have changed.
boolean	doValidation() The page should do any validation on the values set in the page.
java.lang.String	getHelpTopic() Get the help topic for this page.
java.awt.Component	getInitialFocus() The subclass must implement this to return the intial component that should recieve focus on this page.
javax.swing.JPanel	getPanel() Get the panel for this page
boolean	isComplete() Determine whether all mandatory fields on this page have values.
void	pageDeselected() Called when the page has been deselected.
void	pageSelected(boolean forwardMove) Called when a page is selected.
void	removePropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener pcl) Remove a property change listener
void	save() Save the value of controls on the page.
void	setWizard(BasicWizard wiz) The wizard calls this to register itself with the page after the page has been constructed.

Field Detail

COMPLETE_PROPERTY

public static final java.lang.String COMPLETE_PROPERTY

JavaBeans property indicating whether this page is in a complete state (i.e. all mandatory controls have values).

See Also:

Constant Field Values

Method Detail

setWizard

public void setWizard(BasicWizard wiz)

The wizard calls this to register itself with the page after the page has been constructed.

isComplete

public boolean isComplete()

Determine whether all mandatory fields on this page have values. The default implementation always returns true. Subclasses should override this to return true only if all mandatory fields have values. Subclasses should fire a property change event (using the completeValueChanged() method) when the value of this property may have changed.

getHelpTopic

public java.lang.String getHelpTopic()

Get the help topic for this page. The default implementation returns null.

getInitialFocus

public java.awt.Component getInitialFocus()

The subclass must implement this to return the intial component that should recieve focus on this page.

Returns:

a component to receive the initial focus when this page is selected.

pageDeselected

public void pageDeselected()

Called when the page has been deselected. Does nothing by default.

doValidation

public boolean doValidation()

The page should do any validation on the values set in the page. The page is responsible for displaying error UI (alerts). This method is called when the user clicks Next on the page. If a page returns false, the wizard will not advance to the next page.

pageSelected

public void pageSelected(boolean forwardMove)

Called when a page is selected.

Parameters:

forwardMove - true if the user moved forward into this page, false if he moved backwards.

completeValueChanged

public void completeValueChanged()

Subclasses call this when the complete property may have changed. The implementation will normally just fire a property change event to all listeners.

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String property,
                                      java.beans.PropertyChangeListener pcl)

Add a property change listener

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String property,
                                         java.beans.PropertyChangeListener pcl)

Remove a property change listener

getPanel

public javax.swing.JPanel getPanel()

Get the panel for this page

save

public void save()

Save the value of controls on the page.