org.xwiki.gwt.user.client.ui.wizard
Class AbstractInteractiveWizardStep

java.lang.Object
  org.xwiki.gwt.user.client.ui.wizard.AbstractNavigationAwareWizardStep
      org.xwiki.gwt.user.client.ui.wizard.AbstractInteractiveWizardStep

All Implemented Interfaces:

WizardStep

public abstract class AbstractInteractiveWizardStep
extends AbstractNavigationAwareWizardStep

An abstract wizard step that requires user input in order to move forward.

Version:

$Id$

Constructor Summary

AbstractInteractiveWizardStep()
Creates a new composite wizard step.

AbstractInteractiveWizardStep(com.google.gwt.user.client.ui.FlowPanel panel)
Creates a new interactive wizard step that uses the given panel to hold its widgets.

Method Summary

com.google.gwt.user.client.ui.FlowPanel	display() This method is called right after the wizard step has been successfully initialized.
String	getStepTitle()
boolean	isAutoSubmit()
void	setStepTitle(String title) Sets the step title.

Methods inherited from class org.xwiki.gwt.user.client.ui.wizard.AbstractNavigationAwareWizardStep

getDirectionName, getNextStep, getValidDirections, setDirectionName, setNextStep, setValidDirections

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xwiki.gwt.user.client.ui.wizard.WizardStep

getResult, init, onCancel, onSubmit

Constructor Detail

AbstractInteractiveWizardStep

public AbstractInteractiveWizardStep()

Creates a new composite wizard step.

AbstractInteractiveWizardStep

public AbstractInteractiveWizardStep(com.google.gwt.user.client.ui.FlowPanel panel)

Creates a new interactive wizard step that uses the given panel to hold its widgets.

Parameters:

panel - the panel where this wizard step will add its widgets

Method Detail

display

public com.google.gwt.user.client.ui.FlowPanel display()

This method is called right after the wizard step has been successfully initialized.

You can safely use this method to access the panel and add widget to it.

Returns:

the UI representation of this wizard step

See Also:

WizardStep.display()

isAutoSubmit

public final boolean isAutoSubmit()

Returns:

true if this step should be submitted automatically, false otherwise; the WizardStep.display() method should return null if the step is submitted automatically

See Also:

WizardStep.isAutoSubmit()

getStepTitle

public String getStepTitle()

Returns:

the title of the current step, as it should be displayed when the step is shown

See Also:

WizardStep.getStepTitle()

setStepTitle

public void setStepTitle(String title)

Sets the step title.

Parameters:

title - the new step title