Class UIWizardStep

public class UIWizardStep implements IUIWizardStep
{
  // Constructors
  public UIWizardStep( IUIComponent image, IUIComponent content,
        boolean last);
  public UIWizardStep( IUIComponent image, IUIComponent content);

  // Methods
  public IUIComponent getContent();
  public IUIComponent getImage();
  public UIWizardStep getNextStep();
  public UIWizard getWizard();
  public boolean isFinishStep();
  public boolean isLastStep();
  public IUIWizardStep nextStep();
  public IUIWizardStep previousStep();
  public void setNextStep(UIWizardStep step);
  public void setWizard(UIWizard parent);
}

This class implements a wizard page. Each UIWizardStep page is managed by an associated UIWizard object.

Constructors

UIWizardStep

public UIWizardStep( IUIComponent image, IUIComponent content,
        boolean last);

Creates a wizard page using the specified image and content component. You can also designate this page as the wizard's last step.

Parameter	Description
image	The image to be displayed by the page.
content	The component to be displayed by the page. Typically, this component is a String or a UIText object.
last	If true, the page will be the last step in the wizard.

UIWizardStep

public UIWizardStep( IUIComponent image, IUIComponent content);

Creates a wizard page with the specified image and content.

Parameter	Description
image	The image to be displayed by the page.
content	The component to be displayed by the page. Typically, this component is a String or a UIText object.

Methods

getContent

public IUIComponent getContent();

Retrieves the component used for the page's content.

Return Value:

Returns the current content component.

getImage

public IUIComponent getImage();

Retrieves the image displayed by the page.

Return Value:

Returns the current image.

getNextStep

public UIWizardStep getNextStep();

Retrieves the next page in the series of pages managed by an associated wizard.

Return Value:

Returns the next page.

getWizard

public UIWizard getWizard();

Retrieves the wizard associated with the page.

Return Value:

Returns the associated UIWizard object.

See Also: setWizard

isFinishStep

public boolean isFinishStep();

Determines whether the currently viewed page allows a valid selection of the Finish button.

Return Value:

Returns true if the current page is a Finish step; otherwise, returns false.

isLastStep

public boolean isLastStep();

Determines whether the currently viewed page is the last page in the series. If this method returns true, the Next button is replaced by the Finish button.

Return Value:

Returns true if the page is the last step.

nextStep

public IUIWizardStep nextStep();

Retrieves the next page in the series managed by an associated wizard. The previous page is put on the undo stack.

Return Value:

Returns the next page in the series.

See Also: previousStep

previousStep

public IUIWizardStep previousStep();

Retrieves the previous page in the series managed by an associated wizard.

Return Value:

Returns null.

setNextStep

public void setNextStep(UIWizardStep step);

Sets the next page in the series of pages managed by an associated wizard.

Return Value:

No return value.

Parameter	Description
step	The page to be next.

setWizard

public void setWizard(UIWizard parent);

Sets the wizard associated with the page.

Return Value:

No return value.

Parameter	Description
parent	The wizard to be associated with the page.

See Also: getWizard