Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.sapportals.wcm.rendering.screenflow
Class AbstractScreenflow

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.screenflow_api.jar] 
java.lang.Object
  |
  +--com.sapportals.wcm.rendering.screenflow.AbstractScreenflow
All Implemented Interfaces:
IScreenflow
Direct Known Subclasses:
OneStepMassScreenflow, OneStepScreenflow
public abstract class AbstractScreenflow
extends java.lang.Object
implements IScreenflow

Description of the Interface

Inner 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(com.sapportals.wdf.element.PaneElement startPane, com.sapportals.wdf.ControllerDynPage dynpage)
          Creates an IScreenflow instance that holds the needed elements of the Wdf to modify
AbstractScreenflow(com.sapportals.wdf.element.PaneElement startPane, com.sapportals.wcm.rendering.screenflow.PageElement page)
           
 
Method Summary
protected  boolean addScreenflowToStartPane(com.sapportals.wcm.rendering.screenflow.NextScreenElement nse)
          adds the navigation from the given startpane to the first pane of this dynamic screenflow to the given startpane.
protected  com.sapportals.wcm.rendering.screenflow.NextScreenElement createBackScreenElement(java.lang.String event, java.lang.String producerID, int popCount)
           
protected  com.sapportals.wcm.rendering.screenflow.NextScreenElement createNextScreenElement(java.lang.String event, java.lang.String producerID, java.lang.String pane, boolean push)
           
protected  boolean createUniqueControlElement(java.lang.String id, java.lang.String classname, com.sapportals.wcm.rendering.screenflow.ParameterElement[] pre)
           
protected  boolean createUniqueControlElement(java.lang.String id, java.lang.String classname, com.sapportals.wcm.rendering.screenflow.ParameterElement[] pre, com.sapportals.wcm.rendering.screenflow.EventFilterElement[] efe)
           
protected static java.lang.String createUniqueID(java.lang.String id, java.lang.Class cl)
           
protected  boolean createUniquePaneElement(java.lang.String id, AbstractScreenflow.Layout layout, com.sapportals.wcm.rendering.screenflow.ControlReferenceElement cre, com.sapportals.wcm.rendering.screenflow.NextScreenElement nse)
           
protected  boolean createUniquePaneElement(java.lang.String id, AbstractScreenflow.Layout layout, com.sapportals.wcm.rendering.screenflow.ControlReferenceElement cre, com.sapportals.wcm.rendering.screenflow.NextScreenElement[] nse)
           
protected  boolean createUniquePaneElement(java.lang.String id, AbstractScreenflow.Layout layout, com.sapportals.wcm.rendering.screenflow.PaneReferenceElement pre, com.sapportals.wcm.rendering.screenflow.NextScreenElement nse)
           
protected  boolean createUniquePaneElement(java.lang.String id, java.lang.String layout, java.lang.String width, java.lang.String height, com.sapportals.wcm.rendering.screenflow.ControlReferenceElement[] cre, com.sapportals.wcm.rendering.screenflow.NextScreenElement[] nse)
           
protected  boolean createUniquePaneElement(java.lang.String id, java.lang.String layout, java.lang.String width, java.lang.String height, com.sapportals.wcm.rendering.screenflow.PaneReferenceElement[] pre, com.sapportals.wcm.rendering.screenflow.NextScreenElement[] nse)
           
 IRenderingEvent execute()
           
 com.sapportals.wdf.event.WdfEvent execute(boolean pushStack)
           
protected  com.sapportals.wdf.ControllerDynPage getDynPage()
           
protected  com.sapportals.wcm.rendering.screenflow.PageElement getPage()
           
protected  java.lang.String getParamterValue(com.sapportals.wcm.rendering.screenflow.ControlElement control, java.lang.String paramterKey)
           
protected  IScreenflowData getScreenflowData()
           
protected  com.sapportals.wdf.element.PaneElement getStartPane()
           
protected  void initialize(com.sapportals.wdf.element.PaneElement startPane, com.sapportals.wdf.ControllerDynPage dynpage)
           
protected  void initialize(com.sapportals.wdf.element.PaneElement startPane, com.sapportals.wcm.rendering.screenflow.PageElement page)
           
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(com.sapportals.wdf.element.PaneElement startPane,
                          com.sapportals.wdf.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(com.sapportals.wdf.element.PaneElement startPane,
                          com.sapportals.wcm.rendering.screenflow.PageElement page)

AbstractScreenflow

public AbstractScreenflow()
Method Detail

initialize

protected void initialize(com.sapportals.wdf.element.PaneElement startPane,
                          com.sapportals.wdf.ControllerDynPage dynpage)

initialize

protected void initialize(com.sapportals.wdf.element.PaneElement startPane,
                          com.sapportals.wcm.rendering.screenflow.PageElement page)

execute

public com.sapportals.wdf.event.WdfEvent execute(boolean pushStack)
                                          throws com.sapportals.wdf.WdfException
Specified by:
execute in interface IScreenflow

execute

public IRenderingEvent execute()
                        throws WcmException
Specified by:
execute in interface IScreenflow

getScreenflowData

protected IScreenflowData getScreenflowData()

addScreenflowToStartPane

protected final boolean addScreenflowToStartPane(com.sapportals.wcm.rendering.screenflow.NextScreenElement nse)
                                          throws com.sapportals.wdf.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 com.sapportals.wcm.rendering.screenflow.PageElement getPage()
Returns:
the current PageElement of the dynamic screenflow

getDynPage

protected final com.sapportals.wdf.ControllerDynPage getDynPage()
Returns:
the current PageElement of the dynamic screenflow

getStartPane

protected final com.sapportals.wdf.element.PaneElement getStartPane()
Returns:
the PaneElement that is to be replaced with the first PaneElement of this Screenflow

createUniqueID

protected static final java.lang.String createUniqueID(java.lang.String id,
                                                       java.lang.Class cl)

createUniqueControlElement

protected final boolean createUniqueControlElement(java.lang.String id,
                                                   java.lang.String classname,
                                                   com.sapportals.wcm.rendering.screenflow.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(java.lang.String id,
                                                   java.lang.String classname,
                                                   com.sapportals.wcm.rendering.screenflow.ParameterElement[] pre,
                                                   com.sapportals.wcm.rendering.screenflow.EventFilterElement[] efe)

createUniquePaneElement

protected final boolean createUniquePaneElement(java.lang.String id,
                                                java.lang.String layout,
                                                java.lang.String width,
                                                java.lang.String height,
                                                com.sapportals.wcm.rendering.screenflow.ControlReferenceElement[] cre,
                                                com.sapportals.wcm.rendering.screenflow.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(java.lang.String id,
                                                java.lang.String layout,
                                                java.lang.String width,
                                                java.lang.String height,
                                                com.sapportals.wcm.rendering.screenflow.PaneReferenceElement[] pre,
                                                com.sapportals.wcm.rendering.screenflow.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
pre - 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(java.lang.String id,
                                                AbstractScreenflow.Layout layout,
                                                com.sapportals.wcm.rendering.screenflow.PaneReferenceElement pre,
                                                com.sapportals.wcm.rendering.screenflow.NextScreenElement nse)

createUniquePaneElement

protected final boolean createUniquePaneElement(java.lang.String id,
                                                AbstractScreenflow.Layout layout,
                                                com.sapportals.wcm.rendering.screenflow.ControlReferenceElement cre,
                                                com.sapportals.wcm.rendering.screenflow.NextScreenElement nse)

createUniquePaneElement

protected final boolean createUniquePaneElement(java.lang.String id,
                                                AbstractScreenflow.Layout layout,
                                                com.sapportals.wcm.rendering.screenflow.ControlReferenceElement cre,
                                                com.sapportals.wcm.rendering.screenflow.NextScreenElement[] nse)

createNextScreenElement

protected final com.sapportals.wcm.rendering.screenflow.NextScreenElement createNextScreenElement(java.lang.String event,
                                                                                                  java.lang.String producerID,
                                                                                                  java.lang.String pane,
                                                                                                  boolean push)

createBackScreenElement

protected final com.sapportals.wcm.rendering.screenflow.NextScreenElement createBackScreenElement(java.lang.String event,
                                                                                                  java.lang.String producerID,
                                                                                                  int popCount)

writeDebugInformation

protected void writeDebugInformation()

getParamterValue

protected java.lang.String getParamterValue(com.sapportals.wcm.rendering.screenflow.ControlElement control,
                                            java.lang.String paramterKey)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.