com.sapportals.admin.wizardframework.components

Class HTMLScriptComponent

java.lang.Object

com.sapportals.admin.wizardframework.components.AbstractWizardComponent

com.sapportals.admin.wizardframework.components.HTMLScriptComponent

All Implemented Interfaces:

IDependencyObject, IWizardComponent

Direct Known Subclasses:

AbstractScriptState, CancelPane, CloseWizardComponent, FinishPane, RedirectComponent, WriteProtectPane

Deprecated.

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

public class HTMLScriptComponent
extends AbstractWizardComponent

The class that is used to run a JavaScript script on the client in a wizard. When used as a pane, HTMLScriptComponent is rendered without the wizard user interface and the wizard session is not attached to the response. It is assumed that the JavaScript script closes the pane or redirects it.

Field Summary

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

HORIZONTAL_LAYOUT, VERTICAL_LAYOUT

Constructor Summary

Constructors

Constructor and Description
HTMLScriptComponent() Deprecated. A blank constructor.
HTMLScriptComponent(String iScript) Deprecated. A constructor that sets a specified script.

Method Summary

Modifier and Type	Method and Description
com.sapportals.htmlb.Component	getDisplay(IWizardContext ctx) Deprecated. Gets the HTMLB component to display.
String	getScript(IWizardContext ctx) Deprecated. Gets a script from the wizard context.
void	setScript(String newScript, IWizardContext ctx) Deprecated. Sets a script.

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

clearIfInconsistent, doAfterSubmit, doBeforeDisplay, getControlInFocus, getDescription, getErrorMessages, getPath, getProperty, getTitle, init, isComplete, isInitialized, isMandatory, processInput, 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

HTMLScriptComponent

public HTMLScriptComponent(String iScript)

Deprecated.

A constructor that sets a specified script.

Parameters:

iScript - a JavaScript script

HTMLScriptComponent

public HTMLScriptComponent()

Deprecated.

A blank constructor.

Method Detail

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

setScript

public void setScript(String newScript,
                      IWizardContext ctx)

Deprecated.

Sets a script.

Parameters:

newScript - a JavaScript script

ctx - the current wizard context

getScript

public String getScript(IWizardContext ctx)

Deprecated.

Gets a script from the wizard context.

Parameters:

ctx - the current wizard context

Returns:

the JavaScript script