com.sapportals.wcm.rendering.base
Interface IInitialScreenflowProvider

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.base_api.jar]

All Known Implementing Classes:

AbstractUICommand

Deprecated. as of NW04.

public interface IInitialScreenflowProvider

allows to add a dynamic screenflow to a present static (and dynamic) screenflow without the need of a fired WdfEvent of an IUICommand. A typical scenario would look like this: a page is displayed in a new browser window. The name of an IInitialScreenflowProvider is given in the URL. A statically defined Control within the Pane reads out this parameter, creates a new instance of that class and displays its initial control. It also lets the class add its dynamic screenflow to the current ControllerDynPage.

Since:

EP5 SP6 and EP6 SP1

Method Summary

java.util.Map	getInitialControlProperties() Deprecated. returns a map holding properties for the initial controls, where the control's classname acts as the key for the entry.
java.lang.String[]	getInitialControls() Deprecated. returns all controls that are to be rendered on the initial screen.
void	setScreenflow(com.sapportals.wdf.element.PaneElement startPane, com.sapportals.wdf.ControllerDynPage dynpage) Deprecated. adds the screenflow to the currently given screenflows defined in the given dynpage.

Method Detail

setScreenflow

public void setScreenflow(com.sapportals.wdf.element.PaneElement startPane,
                          com.sapportals.wdf.ControllerDynPage dynpage)
                   throws com.sapportals.wdf.WdfException

Deprecated.

adds the screenflow to the currently given screenflows defined in the given dynpage. The implementing class does not have to define a screenflow, e.g., if just an initial control is to be displayed.

Parameters:

startPane - - the pane were to add the NextScreenElements which trigger the move to the next panes, must not be null

dynpage - - the page which holds all defined screenflows, must not be null

Throws:

WdfException - if the Wd-Framework throws exceptions when adding the screenflow

getInitialControls

public java.lang.String[] getInitialControls()

Deprecated.

returns all controls that are to be rendered on the initial screen. The first control in the list is displayed on top of the pane. Must not be null, but can be of length 0

getInitialControlProperties

public java.util.Map getInitialControlProperties()

Deprecated.

returns a map holding properties for the initial controls, where the control's classname acts as the key for the entry. Might return null.