com.sapportals.wcm.rendering.screenflow

Class AbstractScreenflow

java.lang.Object
  com.sapportals.wcm.rendering.screenflow.AbstractScreenflow

All Implemented Interfaces:

IScreenflow

Direct Known Subclasses:

OneStepMassScreenflow, OneStepScreenflow

public abstract class AbstractScreenflow

extends Object

implements IScreenflow

Description of the Interface

Nested Class Summary

static class

AbstractScreenflow.Layout

Field Summary

static ResourceBundles	resBundle
static AbstractScreenflow.Layout	STANDARD

Fields inherited from interface com.sapportals.wcm.rendering.screenflow.IScreenflow

LAYOUT_HORIZ, LAYOUT_VERTI, RENDERINGBACKEVENT, WDFBACKEVENT

Constructor Summary

AbstractScreenflow()

AbstractScreenflow(IScreenflowData sd)

AbstractScreenflow(PaneElement startPane, ControllerDynPage dynpage)
Creates an IScreenflow instance that holds the needed elements of the Wdf to modify

Method Summary

protected boolean	addScreenflowToStartPane(NextScreenElement nse) adds the navigation from the given startpane to the first pane of this dynamic screenflow to the given startpane.
protected NextScreenElement	createBackScreenElement(String event, String producerID, int popCount)
protected NextScreenElement	createNextScreenElement(String event, String producerID, String pane, boolean push)
protected boolean	createUniqueControlElement(String id, String classname, ParameterElement[] pre)
protected boolean	createUniqueControlElement(String id, String classname, ParameterElement[] pre, EventFilterElement[] efe)
protected static String	createUniqueID(String id, Class cl)
protected boolean	createUniquePaneElement(String id, AbstractScreenflow.Layout layout, PaneReferenceElement pre, NextScreenElement nse)
protected boolean	createUniquePaneElement(String id, String layout, String width, String height, ControlReferenceElement[] cre, NextScreenElement[] nse)
IRenderingEvent	execute()
WdfEvent	execute(boolean pushStack)
protected ControllerDynPage	getDynPage()
protected PageElement	getPage()
protected String	getParamterValue(ControlElement control, String paramterKey)
protected IScreenflowData	getScreenflowData()
protected PaneElement	getStartPane()
protected void	initialize(PaneElement startPane, ControllerDynPage dynpage)
protected void	writeDebugInformation()

Methods inherited from class java.lang.Object

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

Field Detail

resBundle

public static ResourceBundles resBundle

STANDARD

public static final AbstractScreenflow.Layout STANDARD

Constructor Detail

AbstractScreenflow

public AbstractScreenflow(PaneElement startPane,
                          ControllerDynPage dynpage)

Creates an IScreenflow instance that holds the needed elements of the Wdf to modify

Parameters:

startPane - this is the pane that has to be replaced by the first pane of the new dynamic screenflow

dynpage - the dynpage that holds the complete information about the user's iView. If the given startPane is not yet an element of the dynamic screenflow, it is added to it.

AbstractScreenflow

public AbstractScreenflow(IScreenflowData sd)

AbstractScreenflow

public AbstractScreenflow()

Method Detail

initialize

protected void initialize(PaneElement startPane,
                          ControllerDynPage dynpage)

execute

public WdfEvent execute(boolean pushStack)
                 throws WdfException

Specified by:

execute in interface IScreenflow

Throws:

WdfException

execute

public IRenderingEvent execute()
                        throws WcmException

Specified by:

execute in interface IScreenflow

Throws:

WcmException

getScreenflowData

protected IScreenflowData getScreenflowData()

addScreenflowToStartPane

protected final boolean addScreenflowToStartPane(NextScreenElement nse)
                                          throws WdfException

adds the navigation from the given startpane to the first pane of this dynamic screenflow to the given startpane. If a NextScreenElement with the triggering event is already defined for this startpane, it is overwritten with the given NextScreenElement.

Parameters:

nse - The feature to be added to the ScreenflowToStartPane attribute

Returns:

true, when a NextScreenElement with this triggering event is already defined for the startpane, false otherwise.

Throws:

WdfException - when null has been given as parameter

getPage

protected final PageElement getPage()

Returns:

the current PageElement of the dynamic screenflow

getDynPage

protected final ControllerDynPage getDynPage()

Returns:

the current PageElement of the dynamic screenflow

getStartPane

protected final PaneElement getStartPane()

Returns:

the PaneElement that is to be replaced with the first PaneElement of this Screenflow

createUniqueID

protected static final String createUniqueID(String id,
                                             Class cl)

createUniqueControlElement

protected final boolean createUniqueControlElement(String id,
                                                   String classname,
                                                   ParameterElement[] pre)

Parameters:

id - Description of the param

classname - Description of the param

pre - Description of the param

Returns:

Description of the Return Value

createUniqueControlElement

protected final boolean createUniqueControlElement(String id,
                                                   String classname,
                                                   ParameterElement[] pre,
                                                   EventFilterElement[] efe)

createUniquePaneElement

protected final boolean createUniquePaneElement(String id,
                                                String layout,
                                                String width,
                                                String height,
                                                ControlReferenceElement[] cre,
                                                NextScreenElement[] nse)

Parameters:

id - - the id of the PaneElement to create. Please note, that this method will not modify this id. If the calling IScreenflow class wants to participate in the namespace concept of the Screenflow package, the id for the pane can be obtained by calling #method createUniqueElementID, giving the id in question as a parameter for that method. adds a pane with the given id to the given PageElement.

layout - Description of the param

width - Description of the param

height - Description of the param

cre - Description of the param

nse - Description of the param

Returns:

true, when the element was created, false , if a pane with this name already existed before

createUniquePaneElement

protected final boolean createUniquePaneElement(String id,
                                                AbstractScreenflow.Layout layout,
                                                PaneReferenceElement pre,
                                                NextScreenElement nse)

createNextScreenElement

protected final NextScreenElement createNextScreenElement(String event,
                                                          String producerID,
                                                          String pane,
                                                          boolean push)

createBackScreenElement

protected final NextScreenElement createBackScreenElement(String event,
                                                          String producerID,
                                                          int popCount)

writeDebugInformation

protected void writeDebugInformation()

getParamterValue

protected String getParamterValue(ControlElement control,
                                  String paramterKey)