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

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.google.gwt.user.client.ui.Composite
              org.xwiki.gwt.user.client.ui.wizard.AbstractCompositeWizardStep
                  org.xwiki.gwt.user.client.ui.wizard.AbstractNavigationAwareWizardStep

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, WizardStep

public abstract class AbstractNavigationAwareWizardStep
extends AbstractCompositeWizardStep

An abstract wizard step that is aware of the wizard navigation.

Version:

$Id: AbstractNavigationAwareWizardStep.java 24888 2009-11-06 02:16:19Z sdumitriu $

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

AbstractNavigationAwareWizardStep()
Creates a new navigation-aware wizard step.

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

Method Summary

java.lang.String	getDirectionName(NavigationListener.NavigationDirection direction) Allows this step to overwrite the default printed for the navigation directions.
java.lang.String	getNextStep() Returns the key of the next step in the wizard.
java.util.EnumSet<NavigationListener.NavigationDirection>	getValidDirections()
java.lang.String	setDirectionName(NavigationListener.NavigationDirection direction, java.lang.String name) Sets the name for a navigation direction.
void	setNextStep(java.lang.String nextStep) Sets the name of the next wizard step.
void	setValidDirections(java.util.EnumSet<NavigationListener.NavigationDirection> validDirections) Sets the valid directions the wizard can go to from this wizard step.

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

display, getPanel

Methods inherited from class com.google.gwt.user.client.ui.Composite

getWidget, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget

addDomHandler, addHandler, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

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

getResult, getStepTitle, init, onCancel, onSubmit

Constructor Detail

AbstractNavigationAwareWizardStep

public AbstractNavigationAwareWizardStep()

Creates a new navigation-aware wizard step.

AbstractNavigationAwareWizardStep

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

Creates a new navigation-aware 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

getDirectionName

public java.lang.String getDirectionName(NavigationListener.NavigationDirection direction)

Allows this step to overwrite the default printed for the navigation directions.

Parameters:

direction - the direction to get the name for

Returns:

the String with the direction name or null if the default should be kept

See Also:

AbstractCompositeWizardStep#getDirectionName(NavigationDirection)

setDirectionName

public java.lang.String setDirectionName(NavigationListener.NavigationDirection direction,
                                         java.lang.String name)

Sets the name for a navigation direction.

Parameters:

direction - a wizard navigation direction

name - a string that will be used on the UI to indicate the specified direction

Returns:

the previous name associated with the given direction

getNextStep

public java.lang.String getNextStep()

Returns the key of the next step in the wizard. Note that this function is called after WizardStep.onSubmit(AsyncCallback) has returned successfully, so the computing of the next step can be done safely at WizardStep.onSubmit(AsyncCallback) time.

Returns:

the key of the next step in the wizard.

See Also:

WizardStep.getNextStep()

setNextStep

public void setNextStep(java.lang.String nextStep)

Sets the name of the next wizard step.

Parameters:

nextStep - the name of the next wizard step

getValidDirections

public java.util.EnumSet<NavigationListener.NavigationDirection> getValidDirections()

Returns:

the set of valid directions from this step.

See Also:

WizardStep.getValidDirections()

setValidDirections

public void setValidDirections(java.util.EnumSet<NavigationListener.NavigationDirection> validDirections)

Sets the valid directions the wizard can go to from this wizard step.

Parameters:

validDirections - the valid directions the wizard can go to from this wizard step