com.sapportals.admin.wizardframework.templates

Class AbstractWizardPane

java.lang.Object
  com.sapportals.admin.wizardframework.components.AbstractWizardComponent
      com.sapportals.admin.wizardframework.components.FlowContainer
          com.sapportals.admin.wizardframework.templates.AbstractWizardPane

All Implemented Interfaces:

IDependencyObject, IWizardComponent, IWizardComponentContainer

Deprecated. Use Admin Studio Wizard Framework, as described in Creating Administration Interfaces (Web Dynpro) on the Help Portal documentation (help.sap.com).

public abstract class AbstractWizardPane
extends FlowContainer

The base class that represents a pane in a wizard. Each pane is a Java class that defines the user interface for one section of the wizard.

Field Summary

Fields inherited from class com.sapportals.admin.wizardframework.components.FlowContainer

HORIZONTAL_LAYOUT, VERTICAL_LAYOUT

Constructor Summary

AbstractWizardPane()
Deprecated. A blank constructor.

Method Summary

com.sapportals.htmlb.Component	getDescriptionComponent(IWizardContext ctx) Deprecated. Gets the description component (the tooltip).
abstract String	getTitle(IWizardContext ctx) Deprecated. Gets the title of a pane.
void	myDoBeforeDisplay(IWizardContext ctx) Deprecated. Performs any initialization before a pane is displayed.
void	myProcessInput(IWizardContext ctx) Deprecated. Processes data entered into the wizard user interface.
void	mySetupComponent(IWizardContext ctx) Deprecated. Implement this method to create your own setup for a component.
protected abstract void	setupPane(IWizardContext ctx, FlowContainer pane) Deprecated. Creates a user interface for a pane.

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

addComponent, addComponent, addComponent, clearIfInconsistent, delegateDoBeforeDisplay, delegateProcessInput, delegateSetupComponent, doAfterSubmit, doBeforeDisplay, getComponent, getControlInFocus, getDisplay, getErrorMessages, getPath, init, isInitialized, processInput, setLayout, setPath, setupComponent, wasChanged

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWizardPane

public AbstractWizardPane()

Deprecated.

A blank constructor.

Method Detail

mySetupComponent

public void mySetupComponent(IWizardContext ctx)

Deprecated.

Implement this method to create your own setup for a component. Calls the SetupPane method.

Overrides:

mySetupComponent in class FlowContainer

Parameters:

ctx - the current wizard context

setupPane

protected abstract void setupPane(IWizardContext ctx,
                                  FlowContainer pane)

Deprecated.

Creates a user interface for a pane. Implement this method by placing components onto a pane.

Parameters:

ctx - the current wizard context

pane - a pane

getTitle

public abstract String getTitle(IWizardContext ctx)

Deprecated.

Gets the title of a pane.

Specified by:

getTitle in interface IWizardComponent

Overrides:

getTitle in class AbstractWizardComponent

Parameters:

ctx - the current wizard context

Returns:

the title of the pane

getDescriptionComponent

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

Deprecated.

Gets the description component (the tooltip).

Parameters:

ctx - the current wizard context

Returns:

the description component

myDoBeforeDisplay

public void myDoBeforeDisplay(IWizardContext ctx)

Deprecated.

Performs any initialization before a pane is displayed. For example, setting the values of HTMLB controls from the data model.

Overrides:

myDoBeforeDisplay in class FlowContainer

Parameters:

ctx - the current wizard context

myProcessInput

public void myProcessInput(IWizardContext ctx)

Deprecated.

Processes data entered into the wizard user interface. Saves to the data model the data from any HTMLB controls in the pane.

Overrides:

myProcessInput in class FlowContainer

Parameters:

ctx - the current wizard context

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/admin/api	api	EP-PIN
[sap.com] EP-RUNTIME	[sap.com] com.sap.portal.admin.wizardframeworkdeprecated	-	EP-PIN-APF
[sap.com] EP-RUNTIME	[sap.com] com.sap.portal.admin.wizardframeworkdeprecated	api	EP-PIN-APF