com.sapportals.admin.wizardframework.components

Class ProgressBarComponent

java.lang.Object
  com.sapportals.admin.wizardframework.components.AbstractWizardComponent
      com.sapportals.admin.wizardframework.components.ProgressBarComponent

All Implemented Interfaces:

IDependencyObject, IWizardComponent

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

public class ProgressBarComponent
extends AbstractWizardComponent

The class that represents the progress bar indicator component.
A progress bar is used to indicate the progress of a background task.

Field Summary

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

HORIZONTAL_LAYOUT, VERTICAL_LAYOUT

Constructor Summary

ProgressBarComponent(com.sap.portal.admin.util.backgroundtasks.AbstractBackgroundTask task)
Deprecated. A constructor that sets a background task.

Method Summary

void	doAfterSubmit(IWizardContext ctx) Deprecated. Performs any actions on the data if the data is valid.
void	doBeforeDisplay(IWizardContext ctx) Deprecated. Performs synchronization between the data model and the pane.
com.sapportals.htmlb.Component	getDisplay(IWizardContext ctx) Deprecated. Gets the HTMLB component to display.
String	getTitle(IWizardContext ctx) Deprecated. Gets a component title.
void	processInput(IWizardContext ctx) Deprecated. Saves to the data model the values entered into wizard controls by the administrator.

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

clearIfInconsistent, getControlInFocus, getDescription, getErrorMessages, getPath, getProperty, init, isComplete, isInitialized, isMandatory, setMandatory, setPath, setProperty, setTempProperty, setupComponent, wasChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressBarComponent

public ProgressBarComponent(com.sap.portal.admin.util.backgroundtasks.AbstractBackgroundTask task)

Deprecated.

A constructor that sets a background task.

Parameters:

task - a background task

Method Detail

doBeforeDisplay

public void doBeforeDisplay(IWizardContext ctx)

Deprecated.

Performs synchronization between the data model and the pane. The default implementation calls the pane�s myDoBeforeDisplay method, and then calls doBeforeDisplay on all the wizard components within the pane.
Override this method to change the standard user interface for a component.

Specified by:

doBeforeDisplay in interface IWizardComponent

Overrides:

doBeforeDisplay in class AbstractWizardComponent

Parameters:

ctx - the current wizard context

getDisplay

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

Deprecated.

Gets the HTMLB component to display. If your component has a display, it should inherit AbstractDisplayComponent or AbstractInputComponent. The default implementation returns null.

Specified by:

getDisplay in interface IWizardComponent

Overrides:

getDisplay in class AbstractWizardComponent

Parameters:

ctx - the current wizard context

Returns:

the component, null if the component has no display

processInput

public void processInput(IWizardContext ctx)

Deprecated.

Saves to the data model the values entered into wizard controls by the administrator. The default implementation calls the pane�s myProcessInput method, and then calls processInput on all the wizard components within the pane.
Implement this method to save to the data model the data from any HTMLB controls that you created in the pane.
This method is called after a user clicks a toolbar button, causing a new request to be made to the wizard component.

Specified by:

processInput in interface IWizardComponent

Overrides:

processInput in class AbstractWizardComponent

Parameters:

ctx - the current wizard context

getTitle

public String getTitle(IWizardContext ctx)

Deprecated.

Description copied from class: AbstractWizardComponent

Gets a component title.

Specified by:

getTitle in interface IWizardComponent

Overrides:

getTitle in class AbstractWizardComponent

Parameters:

ctx - the current wizard context

Returns:

the component title

doAfterSubmit

public void doAfterSubmit(IWizardContext ctx)

Deprecated.

Performs any actions on the data if the data is valid.

Specified by:

doAfterSubmit in interface IWizardComponent

Overrides:

doAfterSubmit in class AbstractWizardComponent

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] com.sap.portal.admin.wizardframeworkdeprecated	api	EP-PIN-APF
[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