com.sapportals.admin.wizardframework.api
Interface IWizardComponent

All Known Implementing Classes:

AbstractWizardComponent

public interface IWizardComponent

Method Summary

void	doAfterSubmit(IWizardContext context) Actions performed after user input was collected should be placed into this function.
void	doBeforeDisplay(IWizardContext context) Do any preparations, that may be needed before display.
com.sapportals.htmlb.Component	getControlInFocus(IWizardContext ctx)
java.lang.String	getDescription(IWizardContext ctx) Set the description of a pane - this function is relevant only for panes.
com.sapportals.htmlb.Component	getDisplay(IWizardContext context) get the htmlb display for this component. in non-display components return null.
java.util.List	getErrorMessages(IWizardContext context)
java.lang.String	getPath() get the path of this component (internally used)
java.lang.String	getTitle(IWizardContext ctx) Set the title of a pane - this function is relevant only for panes.
void	init(IWizardContext context) initialize this component.
boolean	isInitialized(IWizardContext context)
boolean	isMandatory()
void	processInput(IWizardContext context) read the user input from the submitted form here and store it in the session.
void	setMandatory(boolean mandatory)
void	setPath(java.lang.String path) set the path of this component. e.g. it's position in the wizard hierarchy. path components are seperated by IWizardSession.PATH_DELIMITER. example: "personalInfoPane.nameComponent.firstNameInputField"
void	setupComponent(IWizardContext ctx) setup the component here. if this component is a container add all subcomponents here

Method Detail

getTitle

public java.lang.String getTitle(IWizardContext ctx)

Set the title of a pane - this function is relevant only for panes. It won't have any effect if used in subcomponents.

getDescription

public java.lang.String getDescription(IWizardContext ctx)

Set the description of a pane - this function is relevant only for panes. It won't have any effect if used in subcomponents.

setupComponent

public void setupComponent(IWizardContext ctx)

setup the component here. if this component is a container add all subcomponents here

isInitialized

public boolean isInitialized(IWizardContext context)

Returns:

- has this component already been initialized?

init

public void init(IWizardContext context)

initialize this component.

doBeforeDisplay

public void doBeforeDisplay(IWizardContext context)

Do any preparations, that may be needed before display. Note: don't keep the state of the component in member variables of the component between "beforeDisplay()" and "doForm()", since the component is a shared instance. keep it in the session. (the session can keep any object, stateful or not within the same request).

getDisplay

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

get the htmlb display for this component. in non-display components return null.

processInput

public void processInput(IWizardContext context)

read the user input from the submitted form here and store it in the session.

doAfterSubmit

public void doAfterSubmit(IWizardContext context)

Actions performed after user input was collected should be placed into this function.

getErrorMessages

public java.util.List getErrorMessages(IWizardContext context)

Returns:

- If this component was not propperly filled by the user return a list of error messages indicating the missing fields or inconsistencies, otherwise return null;

getPath

public java.lang.String getPath()

get the path of this component (internally used)

setPath

public void setPath(java.lang.String path)

set the path of this component. e.g. it's position in the wizard hierarchy. path components are seperated by IWizardSession.PATH_DELIMITER. example: "personalInfoPane.nameComponent.firstNameInputField"

isMandatory

public boolean isMandatory()

setMandatory

public void setMandatory(boolean mandatory)

Parameters:

is - this component (i.e. the property it collects) a mandatory part of the pane the component resides in? this will influence the display of the component and the behavior of the pane (error messages are displayed only for mandatory components)

getControlInFocus

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