com.sapportals.admin.wizardframework.api

Interface IWizardComponent

All Known Implementing Classes:

AbstractActionComponent, AbstractActionState, AbstractInputComponent, AbstractInputComponent, AbstractScriptState, AbstractSelectionComponent, AbstractWizardComponent, AbstractWizardPane, AlignedInputComponentList, CancelPane, CheckboxChoiceComponent, CheckboxSelectionComponent, CloseWizardComponent, DropdownSelectionComponent, FinishPane, FlowContainer, GridContainer, Group, HtmlbComponentWrapper, HTMLScriptComponent, InfoPane, InitPane, ListDisplayComponent, ListSelectionComponent, MultilineInputComponent, MultiSelectionComponent, ProgressBarComponent, PropertyEditorComponent, RadioButtonSelectionComponent, RedirectComponent, SavePane, SummaryPane, TableViewComponent, TableViewEditorComponent, TextInputComponent, WizardComponentContainer, WriteProtectPane

Deprecated.

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

public interface IWizardComponent

The interface that represents a wizard component. Wizard framework components are used to synchronize a data model item with a user interface control. A wizard component may be a pane in a wizard or an input control for a property in a pane.
Wizard components keep their state by storing their properties in the session. Every wizard component has a unique path. It stores its properties under this path. The delimiter for component paths is a period.
For example, the path for subcomponents should be <parent_component>.<child_component>.
All panes and wizard user interface components implement this interface.

Method Summary

Modifier and Type	Method and Description
void	doAfterSubmit(IWizardContext context) Deprecated. Performs any actions on the data after user input is collected.
void	doBeforeDisplay(IWizardContext context) Deprecated. Performs synchronization between the data model and the pane.
com.sapportals.htmlb.Component	getControlInFocus(IWizardContext ctx) Deprecated. Gets the HTMLB component that currently has the focus.
String	getDescription(IWizardContext ctx) Deprecated. Gets the description of a pane.
com.sapportals.htmlb.Component	getDisplay(IWizardContext context) Deprecated. Gets the HTMLB component to display.
List	getErrorMessages(IWizardContext context) Deprecated. Validates the data for the pane.
String	getPath() Deprecated. Internal use.
String	getTitle(IWizardContext ctx) Deprecated. Gets the title of a pane.
void	init(IWizardContext context) Deprecated. Implement this method to initialize a component.
boolean	isInitialized(IWizardContext context) Deprecated. Indicates whether a component is already initialized.
boolean	isMandatory() Deprecated. Indicates whether a component is mandatory.
void	processInput(IWizardContext context) Deprecated. Saves to the data model the values entered into wizard controls by the administrator.
void	setMandatory(boolean mandatory) Deprecated. Sets a component to be mandatory.
void	setPath(String path) Deprecated. Sets the path of a component.
void	setupComponent(IWizardContext ctx) Deprecated. Configures a component.

Method Detail

getTitle

String getTitle(IWizardContext ctx)

Deprecated.

Gets the title of a pane. This method has no affect on subcomponents.

Parameters:

ctx - the current wizard context

Returns:

String returns the title string

getDescription

String getDescription(IWizardContext ctx)

Deprecated.

Gets the description of a pane. This method has no affect on subcomponents.

Parameters:

ctx - the current wizard context

Returns:

String returns the description string

setupComponent

void setupComponent(IWizardContext ctx)

Deprecated.

Configures a component. If the component is a container, adds the subcomponents.

Parameters:

ctx - the current wizard context

isInitialized

boolean isInitialized(IWizardContext context)

Deprecated.

Indicates whether a component is already initialized.

Parameters:

context - the current wizard context

Returns:

true if the component is initialized, false if not initialized

init

void init(IWizardContext context)

Deprecated.

Implement this method to initialize a component. The default implementation does nothing.

Parameters:

context - the current wizard context

doBeforeDisplay

void doBeforeDisplay(IWizardContext context)

Deprecated.

Performs synchronization between the data model and the pane. The default implementation calls the pane�s myDoBeforeDisplay method, and then calls doBeforeDisplay on all the wizard components within the pane.
Override this method to change the standard user interface for a component.

Parameters:

context - the current wizard context

getDisplay

com.sapportals.htmlb.Component getDisplay(IWizardContext context)

Deprecated.

Gets the HTMLB component to display.

Parameters:

context - the current wizard context

Returns:

the component, null if the component has no display

processInput

void processInput(IWizardContext context)

Deprecated.

Saves to the data model the values entered into wizard controls by the administrator. The default implementation calls the pane�s myProcessInput method, and then calls processInput on all the wizard components within the pane.
Implement this method to save to the data model the data from any HTMLB controls that you created in the pane.
This method is called after a user clicks a toolbar button, causing a new request to be made to the wizard component.

Parameters:

context - the current wizard context

doAfterSubmit

void doAfterSubmit(IWizardContext context)

Deprecated.

Performs any actions on the data after user input is collected. The input data must be valid.

Parameters:

context - the current wizard context

getErrorMessages

List getErrorMessages(IWizardContext context)

Deprecated.

Validates the data for the pane. If the data is valid, the method returns null. If the data is not valid, the method returns a list of error messages.

Parameters:

context - the current wizard context

Returns:

a list of error messages

getPath

String getPath()

Deprecated.

Internal use. Gets the path of a component.

Returns:

the path

setPath

void setPath(String path)

Deprecated.

Sets the path of a component. Path components are separated by IWizardSession.PATH_DELIMITER.
For example: personalInfoPane.nameComponent.firstNameInputField

Parameters:

path - a path for the component

isMandatory

boolean isMandatory()

Deprecated.

Indicates whether a component is mandatory.

Returns:

true if the component is mandatory, false if it is not mandatory

setMandatory

void setMandatory(boolean mandatory)

Deprecated.

Sets a component to be mandatory. Error messages are displayed only for mandatory components.

Parameters:

mandatory - true sets the component to mandatory, false the component is not mandatory

getControlInFocus

com.sapportals.htmlb.Component getControlInFocus(IWizardContext ctx)

Deprecated.

Gets the HTMLB component that currently has the focus.

Parameters:

ctx - the current wizard context

Returns:

the HTMLB component