com.sapportals.admin.wizardframework.api
Interface IConfigurableWizard

public interface IConfigurableWizard

This interface is used to configure the structure of a wizard on startup.

Field Summary

static java.lang.String	BACK
static java.lang.String	CANCEL
static java.lang.String	FINISH
static java.lang.String	NEXT
static java.lang.String	PREV Deprecated. use BACK
static java.lang.String	TRANSITION_FROM_ANY_PANE

Method Summary

void	addDependency(java.lang.String sourceObjectPath, java.lang.String targetObjectPath) Add a dependency between 2 objects in this wizard. dependencies may be between panes or sub components/properties.
void	addPane(java.lang.String key, IWizardComponent pane) Deprecated. Since wizards will be instantiated dynamically using this function carries a serious ferformance penalty. add a state (pane) to this wizard. the IWizardComponent instance added will be shared among all instances/invocations of this wizard.
void	addPane(java.lang.String key, java.lang.String implementationClassName) add a state (pane) to this wizard use. a new instance of implementationClass will be created for each request. so the component may safely store request specific state in the implementation classes' member variables.
void	addPane(java.lang.String key, java.lang.String implementationClassName, java.lang.Object[] constructorArguments) add a state (pane) to this wizard use. a new instance of implementationClass will be created for each request. so the component may safely store request specific state in the implementation classes' member variables.
void	addTransition(java.lang.String fromPane, java.lang.String event, ICondition condition, java.lang.String toPane) add a transition between the states of this wizard.
void	setCustomScriptingComponent(com.sapportals.htmlb.Component scriptingComponent)
void	setTitle(java.lang.String title) set the wizard's title.
void	showWizardGui(boolean showStepNo, boolean showButtons) you may use this function to disable the standard wizard gui or parts of it if your wizard does not need the standard wizard gui or wants to repace it.

Field Detail

NEXT

public static final java.lang.String NEXT

BACK

public static final java.lang.String BACK

PREV

public static final java.lang.String PREV

Deprecated. use BACK

FINISH

public static final java.lang.String FINISH

CANCEL

public static final java.lang.String CANCEL

TRANSITION_FROM_ANY_PANE

public static final java.lang.String TRANSITION_FROM_ANY_PANE

Method Detail

setTitle

public void setTitle(java.lang.String title)

set the wizard's title. The title will be displayed on the upper frame of the wizard window.

showWizardGui

public void showWizardGui(boolean showStepNo,
                          boolean showButtons)

you may use this function to disable the standard wizard gui or parts of it if your wizard does not need the standard wizard gui or wants to repace it.

addPane

public void addPane(java.lang.String key,
                    IWizardComponent pane)

Deprecated. Since wizards will be instantiated dynamically using this function carries a serious ferformance penalty. add a state (pane) to this wizard. the IWizardComponent instance added will be shared among all instances/invocations of this wizard.

addPane

public void addPane(java.lang.String key,
                    java.lang.String implementationClassName)

add a state (pane) to this wizard use. a new instance of implementationClass will be created for each request. so the component may safely store request specific state in the implementation classes' member variables.

addPane

public void addPane(java.lang.String key,
                    java.lang.String implementationClassName,
                    java.lang.Object[] constructorArguments)

add a state (pane) to this wizard use. a new instance of implementationClass will be created for each request. so the component may safely store request specific state in the implementation classes' member variables.

addTransition

public void addTransition(java.lang.String fromPane,
                          java.lang.String event,
                          ICondition condition,
                          java.lang.String toPane)

add a transition between the states of this wizard. Transitions may be conditional or unconditional (use a null condition for unconditional transitions). You'll only need to use this function if your wizard is not simply a linear series of panes. In this trivial case The framework will automatically create a set of transitions based on the order the panes are added to the wizard in.

addDependency

public void addDependency(java.lang.String sourceObjectPath,
                          java.lang.String targetObjectPath)

Add a dependency between 2 objects in this wizard. dependencies may be between panes or sub components/properties. If the target object implements IDependencyObject the framework will call the target's clearIfInconsistent(changedObjectKey) method whenever the source object calls it's wasChanged() method after having been modified. If the target object does not implements IDependencyObject the framework will simply delete all properties below targetObjectPath ( i.e. any property named targetObjectPath.* ) from the session.

setCustomScriptingComponent

public void setCustomScriptingComponent(com.sapportals.htmlb.Component scriptingComponent)