com.sapportals.admin.wizardframework.api

Interface IConfigurableWizard

Deprecated.

Use Admin Studio Wizard Framework, as described in Creating Administration Interfaces (Web Dynpro) on the Help Portal documentation (help.sap.com).

public interface IConfigurableWizard

The interface that defines methods for configuring a wizard at startup. The configurable wizard object can be used to add panes, create transitions and data dependencies.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BACK Deprecated. A constant that indicates the Back button on the wizard toolbar.
static String	CANCEL Deprecated. A constant that indicates the Cancel button on the wizard toolbar.
static String	FINISH Deprecated. A constant that indicates the Finish button on the wizard toolbar.
static String	NEXT Deprecated. A constant that indicates the Next button on the wizard toolbar.
static String	PREV Deprecated. use BACK
static String	TRANSITION_FROM_ANY_PANE Deprecated. A constant that indicates a transition between panes.

Method Summary

Modifier and Type	Method and Description
void	addDependency(String sourceObjectPath, String targetObjectPath) Deprecated. Adds a dependency between two objects in the wizard.
void	addPane(String key, IWizardComponent pane) Deprecated. use addPane( String key, IWizardComponent pane )
void	addPane(String key, String implementationClassName) Deprecated. Adds a pane to the wizard.
void	addPane(String key, String implementationClassName, Object[] constructorArguments) Deprecated. Adds a pane to the wizard.
void	addTransition(String fromPane, String event, ICondition condition, String toPane) Deprecated. Adds a transition between the states of a wizard.
void	setCustomScriptingComponent(com.sapportals.htmlb.Component scriptingComponent) Deprecated. Sets the custom scripting component for each HTMLScriptComponent in a pane.
void	setTitle(String title) Deprecated. Sets a wizard title.
void	showWizardGui(boolean showStepNo, boolean showButtons) Deprecated. Indicates whether to use the standard wizard user interface.

Field Detail

NEXT

static final String NEXT

Deprecated.

A constant that indicates the Next button on the wizard toolbar.
NEXT

See Also:

Constant Field Values

BACK

static final String BACK

Deprecated.

A constant that indicates the Back button on the wizard toolbar.
BACK

See Also:

Constant Field Values

PREV

static final String PREV

Deprecated. use BACK

A constant that indicates the Previous button on the wizard toolbar.
IConfigurableWizard.PREV

See Also:

Constant Field Values

FINISH

static final String FINISH

Deprecated.

A constant that indicates the Finish button on the wizard toolbar.
FINISH

See Also:

Constant Field Values

CANCEL

static final String CANCEL

Deprecated.

A constant that indicates the Cancel button on the wizard toolbar.
CANCEL

See Also:

Constant Field Values

TRANSITION_FROM_ANY_PANE

static final String TRANSITION_FROM_ANY_PANE

Deprecated.

A constant that indicates a transition between panes. Used to distinguish between a general transition and a specific transition
fromAnyPane

See Also:

Constant Field Values

Method Detail

setTitle

void setTitle(String title)

Deprecated.

Sets a wizard title. The title is displayed in the upper frame of the wizard window.

Parameters:

title - a title

showWizardGui

void showWizardGui(boolean showStepNo,
                   boolean showButtons)

Deprecated.

Indicates whether to use the standard wizard user interface.

Parameters:

showStepNo - true shows the step number, false hides the step number

showButtons - true shows buttons, false hides buttons

addPane

void addPane(String key,
             IWizardComponent pane)

Deprecated. use addPane( String key, IWizardComponent pane )

Adds a pane to the wizard. Since wizards are instantiated dynamically, using this function carries a serious performance penalty.

Parameters:

key - a key for the pane

pane - a pane to add

addPane

void addPane(String key,
             String implementationClassName)

Deprecated.

Adds a pane to the wizard. A new instance of implementationClass is created for each request so the component can store request specific states in the implementation class's member variables.

Parameters:

key - a key for the pane

implementationClassName - the class name

addPane

void addPane(String key,
             String implementationClassName,
             Object[] constructorArguments)

Deprecated.

Adds a pane to the wizard. Passes an array of objects to the constructor. A new instance of implementationClass is created for each request so the component can store request specific state information in the implementation class's member variables.

Parameters:

key - a key for the pane

implementationClassName - the class name

constructorArguments - a constructor

addTransition

void addTransition(String fromPane,
                   String event,
                   ICondition condition,
                   String toPane)

Deprecated.

Adds a transition between the states of a wizard. Transitions may be conditional or unconditional. Use a null condition for unconditional transitions.
This method is used if your wizard is not a simple linear series of panes. For a simple linear series of panes, the framework automatically creates a set of transitions based on the order in which the panes are added to the wizard.

Parameters:

fromPane - the key for the source pane used in addPane

event - an event that triggers a transition

condition - a condition

toPane - a target pane

addDependency

void addDependency(String sourceObjectPath,
                   String targetObjectPath)

Deprecated.

Adds a dependency between two objects in the wizard. Dependencies may be between panes or subcomponents/properties.
If the target object implements IDependencyObject, the framework calls the target's clearIfInconsistent(changedObjectKey) method whenever the source object calls its wasChanged() method after having been modified. If the target object does not implement IDependencyObject the framework simply deletes all properties below the targetObjectPath from the session. (i.e. any property named targetObjectPath.*)

Parameters:

sourceObjectPath - a source path

targetObjectPath - a target path

setCustomScriptingComponent

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

Deprecated.

Sets the custom scripting component for each HTMLScriptComponent in a pane. The script is run for every pane in the wizard.

Parameters:

scriptingComponent - a JavaScript script