com.sapportals.admin.wizardframework.components
Class FlowContainer

java.lang.Object
  |
  +--com.sapportals.admin.wizardframework.components.AbstractWizardComponent
        |
        +--com.sapportals.admin.wizardframework.components.FlowContainer

All Implemented Interfaces:

IDependencyObject, IWizardComponent, IWizardComponentContainer

Direct Known Subclasses:

AbstractWizardPane, Group

public class FlowContainer

extends AbstractWizardComponent

implements IWizardComponentContainer

This wizard component can contain other wizard components. It will execute enclosed components in the correct order. if component a was added to a container before component b the container shall call a.init(), b.init(), a.doBeforeDisplay(), b.doBeforeDisplay...

Field Summary

static int	HORIZONTAL_LAYOUT
static int	VERTICAL_LAYOUT

Constructor Summary

FlowContainer()
Sorry, no documentation comment here

FlowContainer(int iLayout)
Sorry, no documentation comment here

FlowContainer(int iLayout, int iPadding)
Sorry, no documentation comment here

Method Summary

void	addComponent(java.lang.String key, com.sapportals.htmlb.Component component)
void	addComponent(java.lang.String key, IWizardComponent component)
void	addComponent(java.lang.String key, IWizardComponent component, boolean isMandatoryField)
void	clearIfInconsistent(java.lang.String changedObjectKey, IWizardContext context) the default implementtion clears all values from this component's branch in the session.
protected void	delegateDoBeforeDisplay(IWizardContext context)
protected void	delegateProcessInput(IWizardContext ctx)
protected void	delegateSetupComponent(IWizardContext context)
void	doAfterSubmit(IWizardContext context) the default implemention does nothing
void	doBeforeDisplay(IWizardContext context) the default implemention does nothing before display
IWizardComponent	getComponent(java.lang.String key) get a (sub)component from this container
com.sapportals.htmlb.Component	getControlInFocus(IWizardContext ctx)
com.sapportals.htmlb.Component	getDisplay(IWizardContext context) the default implementation returns null - if your component has a display it should inherit AbstractDisplayComponent or AbstractInputComponent.
java.util.List	getErrorMessages(IWizardContext context) the default implemention returns null
java.lang.String	getPath() get the path of this component (internally used)
void	init(IWizardContext context) the default implemention does nothing on init
boolean	isInitialized(IWizardContext context) always returns true - override this function if your component needs dynamic initialization
protected void	myDoBeforeDisplay(IWizardContext ctx)
protected void	myProcessInput(IWizardContext ctx)
protected void	mySetupComponent(IWizardContext context)
void	processInput(IWizardContext ctx) the default implemention does no input processing.
void	setLayout(int iLayout)
void	setPath(java.lang.String iPath) set the path of this component. e.g. it's position in the wizard hierarchy. path components are seperated by IWizardSession.PATH_DELIMITER. example: "pane1.nameComponent.firstNameInputField".
void	setupComponent(IWizardContext context) setup the component here. if this component is a container add all subcomponents here
void	wasChanged(IWizardContext context) this method should be called whenever a component is changed.

Methods inherited from class com.sapportals.admin.wizardframework.components.AbstractWizardComponent

getDescription, getProperty, getTitle, isComplete, isMandatory, setMandatory, setProperty, setTempProperty

Methods inherited from class java.lang.Object

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

Field Detail

VERTICAL_LAYOUT

public static final int VERTICAL_LAYOUT

HORIZONTAL_LAYOUT

public static final int HORIZONTAL_LAYOUT

Constructor Detail

FlowContainer

public FlowContainer()

Sorry, no documentation comment here

FlowContainer

public FlowContainer(int iLayout)

Sorry, no documentation comment here

Parameters:

int - iLayout

FlowContainer

public FlowContainer(int iLayout,
                     int iPadding)

Sorry, no documentation comment here

Parameters:

int - iLayout

int - iPadding

Method Detail

addComponent

public void addComponent(java.lang.String key,
                         IWizardComponent component)

addComponent

public void addComponent(java.lang.String key,
                         IWizardComponent component,
                         boolean isMandatoryField)

addComponent

public void addComponent(java.lang.String key,
                         com.sapportals.htmlb.Component component)

getComponent

public IWizardComponent getComponent(java.lang.String key)

Description copied from interface: IWizardComponentContainer

get a (sub)component from this container

Specified by:

getComponent in interface IWizardComponentContainer

setupComponent

public void setupComponent(IWizardContext context)

Description copied from interface: IWizardComponent

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

Overrides:

setupComponent in class AbstractWizardComponent

delegateSetupComponent

protected void delegateSetupComponent(IWizardContext context)

mySetupComponent

protected void mySetupComponent(IWizardContext context)

isInitialized

public boolean isInitialized(IWizardContext context)

Description copied from class: AbstractWizardComponent

always returns true - override this function if your component needs dynamic initialization

Overrides:

isInitialized in class AbstractWizardComponent

Following copied from interface: com.sapportals.admin.wizardframework.api.IWizardComponent

Returns:

- has this component already been initialized?

init

public void init(IWizardContext context)

Description copied from class: AbstractWizardComponent

the default implemention does nothing on init

Overrides:

init in class AbstractWizardComponent

doBeforeDisplay

public void doBeforeDisplay(IWizardContext context)

Description copied from class: AbstractWizardComponent

the default implemention does nothing before display

Overrides:

doBeforeDisplay in class AbstractWizardComponent

delegateDoBeforeDisplay

protected void delegateDoBeforeDisplay(IWizardContext context)

myDoBeforeDisplay

protected void myDoBeforeDisplay(IWizardContext ctx)

processInput

public void processInput(IWizardContext ctx)

Description copied from class: AbstractWizardComponent

the default implemention does no input processing.

Overrides:

processInput in class AbstractWizardComponent

delegateProcessInput

protected void delegateProcessInput(IWizardContext ctx)

myProcessInput

protected void myProcessInput(IWizardContext ctx)

doAfterSubmit

public void doAfterSubmit(IWizardContext context)

Description copied from class: AbstractWizardComponent

the default implemention does nothing

Overrides:

doAfterSubmit in class AbstractWizardComponent

getPath

public java.lang.String getPath()

Description copied from class: AbstractWizardComponent

get the path of this component (internally used)

Overrides:

getPath in class AbstractWizardComponent

setPath

public void setPath(java.lang.String iPath)

Description copied from class: AbstractWizardComponent

set the path of this component. e.g. it's position in the wizard hierarchy. path components are seperated by IWizardSession.PATH_DELIMITER. example: "pane1.nameComponent.firstNameInputField". If this component contains other components it will set their path in this function.

Overrides:

setPath in class AbstractWizardComponent

setLayout

public void setLayout(int iLayout)

getDisplay

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

Description copied from class: AbstractWizardComponent

the default implementation returns null - if your component has a display it should inherit AbstractDisplayComponent or AbstractInputComponent.

Overrides:

getDisplay in class AbstractWizardComponent

wasChanged

public void wasChanged(IWizardContext context)

Description copied from class: AbstractWizardComponent

this method should be called whenever a component is changed. It clears all components dependent on this component or its parent components.

Overrides:

wasChanged in class AbstractWizardComponent

clearIfInconsistent

public void clearIfInconsistent(java.lang.String changedObjectKey,
                                IWizardContext context)

Description copied from class: AbstractWizardComponent

the default implementtion clears all values from this component's branch in the session.

Overrides:

clearIfInconsistent in class AbstractWizardComponent

getErrorMessages

public java.util.List getErrorMessages(IWizardContext context)

Description copied from class: AbstractWizardComponent

the default implemention returns null

Overrides:

getErrorMessages in class AbstractWizardComponent

Following copied from interface: com.sapportals.admin.wizardframework.api.IWizardComponent

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;

getControlInFocus

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

Overrides:

getControlInFocus in class AbstractWizardComponent