com.sapportals.admin.wizardframework.components

Class AbstractWizardComponent

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

All Implemented Interfaces:

IDependencyObject, IWizardComponent

Direct Known Subclasses:

AbstractActionComponent, AbstractInputComponent, AlignedInputComponentList, FlowContainer, GridContainer, HtmlbComponentWrapper, HTMLScriptComponent, ListDisplayComponent, ProgressBarComponent, PropertyEditorComponent, WizardComponentContainer

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

public class AbstractWizardComponent
extends Object
implements IWizardComponent, IDependencyObject

The base class that represents a wizard component. This is the default component implementation all wizard components should inherit.
It provides default implementations for all the functions in IWizardComponent while not defining any individual behavior.

Field Summary

static int	HORIZONTAL_LAYOUT Deprecated. A constant that indicates the horizontal layout.
static int	VERTICAL_LAYOUT Deprecated. A constant that indicates the vertical layout.

Constructor Summary

AbstractWizardComponent()
Deprecated.

Method Summary

void	clearIfInconsistent(String changedObject, IWizardContext context) Deprecated. Clears all values from the object and its subtree when the object this object depends on was changed.
void	doAfterSubmit(IWizardContext context) Deprecated. Performs any actions on the data if the data is valid.
void	doBeforeDisplay(IWizardContext context) Deprecated. Performs synchronization between the data model and the pane.
com.sapportals.htmlb.Component	getControlInFocus(IWizardContext ctx) Deprecated. Gets the control that currently has the focus.
String	getDescription(IWizardContext ctx) Deprecated. Gets a component description.
com.sapportals.htmlb.Component	getDisplay(IWizardContext context) Deprecated. Gets the HTMLB component to display.
List	getErrorMessages(IWizardContext context) Deprecated. Validates the data for the pane.
String	getPath() Deprecated. Gets the path of the component.
protected Object	getProperty(String key, IBasicEditingContext context) Deprecated. Gets the properties for an object specified by a key.
String	getTitle(IWizardContext ctx) Deprecated. Gets a component title.
void	init(IWizardContext context) Deprecated. Implement this method to initialize a component.
boolean	isComplete(IWizardContext context) Deprecated. Indicates whether there is input in the component (true).
boolean	isInitialized(IWizardContext context) Deprecated. Indicates whether the component is initialized (true).
boolean	isMandatory() Deprecated. Indicates whether a component is mandatory (true).
void	processInput(IWizardContext context) Deprecated. Saves to the data model the values entered into wizard controls by the administrator.
void	setMandatory(boolean iMandatory) Deprecated. Sets a component to mandatory.
void	setPath(String iPath) Deprecated. Sets a component path.
protected void	setProperty(String key, Object value, IBasicEditingContext context) Deprecated. Sets the value for a property in the session specified by a key.
protected void	setTempProperty(String key, Object value, IBasicEditingContext context) Deprecated. Sets the temporary property for a specified key in the session.
void	setupComponent(IWizardContext ctx) Deprecated. Configures a component.
void	wasChanged(IWizardContext context) Deprecated. Clears all objects dependent on this object or its parent objects.

Methods inherited from class java.lang.Object

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

Field Detail

VERTICAL_LAYOUT

public static final int VERTICAL_LAYOUT

Deprecated.

A constant that indicates the vertical layout.

See Also:

Constant Field Values

HORIZONTAL_LAYOUT

public static final int HORIZONTAL_LAYOUT

Deprecated.

A constant that indicates the horizontal layout.

See Also:

Constant Field Values

Constructor Detail

AbstractWizardComponent

public AbstractWizardComponent()

Deprecated.

Method Detail

setupComponent

public void setupComponent(IWizardContext ctx)

Deprecated.

Configures a component. If the component is a container, adds the subcomponents.

Specified by:

setupComponent in interface IWizardComponent

Parameters:

ctx - the current wizard context

getTitle

public String getTitle(IWizardContext ctx)

Deprecated.

Gets a component title.

Specified by:

getTitle in interface IWizardComponent

Parameters:

ctx - the current wizard context

Returns:

the component title

getDescription

public String getDescription(IWizardContext ctx)

Deprecated.

Gets a component description.

Specified by:

getDescription in interface IWizardComponent

Parameters:

ctx - the current wizard context

Returns:

the component description

setPath

public void setPath(String iPath)

Deprecated.

Sets a component path. Path components are separated by IWizardSession.PATH_DELIMITER.
For example: pane1.nameComponent.firstNameInputField. If this component contains subcomponents, the path for the subcomponents is also set.

Specified by:

setPath in interface IWizardComponent

Parameters:

iPath - a component path

getPath

public String getPath()

Deprecated.

Gets the path of the component.

Specified by:

getPath in interface IWizardComponent

Returns:

the path

getProperty

protected Object getProperty(String key,
                             IBasicEditingContext context)

Deprecated.

Gets the properties for an object specified by a key.

Parameters:

key - a key

context - the current context

Returns:

the properties

setProperty

protected void setProperty(String key,
                           Object value,
                           IBasicEditingContext context)

Deprecated.

Sets the value for a property in the session specified by a key.

Parameters:

key - a key

value - a value to set

context - the current context

setTempProperty

protected void setTempProperty(String key,
                               Object value,
                               IBasicEditingContext context)

Deprecated.

Sets the temporary property for a specified key in the session. The property is not stored in the response and is available only in this request.

Parameters:

key - a key

value - a value to set

context - the current context

isInitialized

public boolean isInitialized(IWizardContext context)

Deprecated.

Indicates whether the component is initialized (true). Always returns true. Override this method if the component requires dynamic initialization.

Specified by:

isInitialized in interface IWizardComponent

Parameters:

context - the current wizard context

Returns:

true

init

public void init(IWizardContext context)

Deprecated.

Implement this method to initialize a component. The default implementation does nothing.

Specified by:

init in interface IWizardComponent

Parameters:

context - the current wizard context

doBeforeDisplay

public void doBeforeDisplay(IWizardContext context)

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

Parameters:

context - the current wizard context

getDisplay

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

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

Parameters:

context - the current wizard context

Returns:

the component, null if the component has no display

processInput

public void processInput(IWizardContext context)

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

Parameters:

context - the current wizard context

doAfterSubmit

public void doAfterSubmit(IWizardContext context)

Deprecated.

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

Specified by:

doAfterSubmit in interface IWizardComponent

Parameters:

context - the current wizard context

wasChanged

public void wasChanged(IWizardContext context)

Deprecated.

Clears all objects dependent on this object or its parent objects. Called whenever an object is changed.

Specified by:

wasChanged in interface IDependencyObject

Parameters:

context - the current wizard context

clearIfInconsistent

public void clearIfInconsistent(String changedObject,
                                IWizardContext context)

Deprecated.

Clears all values from the object and its subtree when the object this object depends on was changed.
The default implementation clears all values from the component's branch in the session.

Specified by:

clearIfInconsistent in interface IDependencyObject

Parameters:

changedObject - a changed object

context - the current wizard context

isComplete

public boolean isComplete(IWizardContext context)

Deprecated.

Indicates whether there is input in the component (true). The default implementation returns true.

Parameters:

context - the current wizard context

Returns:

true if there is input, false no input

getErrorMessages

public List getErrorMessages(IWizardContext context)

Deprecated.

Validates the data for the pane. If the data is valid, the method returns null. If the data is not valid, the method returns a list of error messages.

Specified by:

getErrorMessages in interface IWizardComponent

Parameters:

context - the current wizard context

Returns:

a list of error messages

isMandatory

public boolean isMandatory()

Deprecated.

Indicates whether a component is mandatory (true).

Specified by:

isMandatory in interface IWizardComponent

Returns:

true if it is mandatory, false if not

setMandatory

public void setMandatory(boolean iMandatory)

Deprecated.

Sets a component to mandatory. Error messages are displayed only for mandatory components.

Specified by:

setMandatory in interface IWizardComponent

Parameters:

iMandatory - true sets the component to mandatory, false if not mandatory

getControlInFocus

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

Deprecated.

Gets the control that currently has the focus.

Specified by:

getControlInFocus in interface IWizardComponent

Parameters:

ctx - the current wizard context

Returns:

null

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