com.sapportals.admin.wizardframework

Class AbstractDynamicWizard

java.lang.Object
  com.sapportals.portal.prt.component.AbstractPortalComponent
      com.sapportals.admin.wizardframework.AbstractDynamicWizard

All Implemented Interfaces:

IDynamicWizardConfigurator, IWizardConfigurator, IEventListenerComponent, IPortalComponent, IPortalComponentInit

Direct Known Subclasses:

AbstractWizard

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

public abstract class AbstractDynamicWizard
extends AbstractPortalComponent
implements IDynamicWizardConfigurator

A class that defines a dynamic wizard. Extend this class and implement IDynamicWizardConfigurator.setupWizard(IConfigurableWizard, IPortalComponentProfile, Map, ResourceBundle) to define a dynamic wizard.
In dynamic wizards (as opposed to static wizards), a new instance of the wizard structure is created for each request, such that a wizard structure can be created using arguments. It is recommended, for performance reasons, to add panes by using their class names rather than by adding pane instances.
Each wizard has a toolbar containing a set of buttons used for navigating between panes in the wizard. The toolbar contains the following buttons.

• Cancel: Close the wizard without taking any action.
• Back: Go back to the previous pane.
• Next: Go to the next pane.
• Finish: Close the wizard and take any necessary action based on the input in the wizard. You must define the actions in a non-visible pane which you navigate to after Finish is clicked.

Field Summary

static String	BACK Deprecated. A constant that defines the Back button on the wizard toolbar.
static String	CANCEL Deprecated. A constant that defines the Cancel button on the wizard toolbar.
static String	FINISH Deprecated. A constant that defines the Finish button on the wizard toolbar.
static String	NEXT Deprecated. A constant that defines the Next button on the wizard toolbar.
static String	PREV Deprecated. A constant that defines the Previous button on the wizard toolbar.
static String	STEP_NO_OFFSET Deprecated. A constant that defines the step offset.
static String	WIZARD_PARAMETERS Deprecated. The key to store the session parameters.

Constructor Summary

AbstractDynamicWizard()
Deprecated.

Method Summary

protected void	doContent(IPortalComponentRequest request, IPortalComponentResponse response) Deprecated. Performs the logic for the wizard instance.
void	initWizardSession(IWizardContext ctx) Deprecated. Initializes the wizard session.
Map	processWizardParams(Map originalParams) Deprecated. Processes the wizard parameters after the wizard setup.

Methods inherited from class com.sapportals.portal.prt.component.AbstractPortalComponent

destroy, doAbout, doAfterContent, doBeforeContent, doComponentEvent, doEdit, doHandleEditData, doHelp, doOnNodeReady, doOnNodeRemove, doOnPOMReady, doPreview, doRefresh, doRequestEvent, getCacheDiscriminant, getCachingLevel, handleEvent, hasExpired, init, init, init, service

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sapportals.admin.wizardframework.api.IDynamicWizardConfigurator

setupWizard

Field Detail

NEXT

public static final String NEXT

Deprecated.

A constant that defines the Next button on the wizard toolbar.
IConfigurableWizard.NEXT

See Also:

Constant Field Values

BACK

public static final String BACK

Deprecated.

A constant that defines the Back button on the wizard toolbar.
IConfigurableWizard.BACK

See Also:

Constant Field Values

PREV

public static final String PREV

Deprecated.

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

See Also:

Constant Field Values

FINISH

public static final String FINISH

Deprecated.

A constant that defines the Finish button on the wizard toolbar.
IConfigurableWizard.FINISH

See Also:

Constant Field Values

CANCEL

public static final String CANCEL

Deprecated.

A constant that defines the Cancel button on the wizard toolbar.
IConfigurableWizard.CANCEL

See Also:

Constant Field Values

WIZARD_PARAMETERS

public static final String WIZARD_PARAMETERS

Deprecated.

The key to store the session parameters.
com.sapportals.admin.wizardframework.util.WizardSession.WIZARD_PARAMETERS

See Also:

Constant Field Values

STEP_NO_OFFSET

public static final String STEP_NO_OFFSET

Deprecated.

A constant that defines the step offset. Used to determine if the wizard step number starts at 1 or if there is an offset. For example, if the wizard is a continuation of another wizard, an offset is required.
step_offset

See Also:

Constant Field Values

Constructor Detail

AbstractDynamicWizard

public AbstractDynamicWizard()

Deprecated.

Method Detail

doContent

protected void doContent(IPortalComponentRequest request,
                         IPortalComponentResponse response)

Deprecated.

Performs the logic for the wizard instance. Creates a wizard instance and runs the doWizard method.

Specified by:

doContent in class AbstractPortalComponent

Parameters:

request - a portal request

response - a portal response

processWizardParams

public Map processWizardParams(Map originalParams)

Deprecated.

Processes the wizard parameters after the wizard setup.

Specified by:

processWizardParams in interface IWizardConfigurator

Parameters:

originalParams - initial parameters

Returns:

a map of parameters

initWizardSession

public void initWizardSession(IWizardContext ctx)

Deprecated.

Initializes the wizard session.

Specified by:

initWizardSession in interface IWizardConfigurator

Parameters:

ctx - the current wizard context

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] com.sap.portal.admin.wizardframeworkdeprecated	api	EP-PIN-APF
[sap.com] EP-RUNTIME	[sap.com] com.sap.portal.admin.wizardframeworkdeprecated	-	EP-PIN-APF
[sap.com] EP-RUNTIME	[sap.com] tc/ep/admin/api	api	EP-PIN