com.sapportals.admin.wizardframework.components

Class WizardComponentContainer

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

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 class WizardComponentContainer
extends AbstractWizardComponent
implements IWizardComponentContainer

The class that represents a wizard component container. A container can contain other wizard components. It executes enclosed components in the order in which the component was added to the container.
For example, if component a was added to a container before component b the container calls a.init(), b.init(), a.doBeforeDisplay(), b.doBeforeDisplay.

Field Summary

protected Hashtable	components Deprecated. Returns a hashtable that is used as a container for the subcomponents.
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

WizardComponentContainer()
Deprecated. A blank constructor.

WizardComponentContainer(int iLayout)
Deprecated. A constructor that sets a layout.

WizardComponentContainer(int iLayout, int iPadding)
Deprecated. A constructor that sets a layout and padding.

Method Summary

void	addComponent(String key, com.sapportals.htmlb.Component component) Deprecated. Adds a specified HTMLB component.
void	addComponent(String key, IWizardComponent component) Deprecated. Adds a specified component.
void	addComponent(String key, IWizardComponent component, boolean isMandatoryField) Deprecated. Adds a specified wizard component and sets the component to mandatory (true).
void	clearIfInconsistent(String changedObjectKey, 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.
IWizardComponent	getComponent(String key) Deprecated. Gets the specified component.
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 this component.
void	init(IWizardContext context) Deprecated. Implement this method to initialize a component.
boolean	isInitialized(IWizardContext context) Deprecated. Indicates whether a component is initialized.
void	processInput(IWizardContext context) Deprecated. Saves to the data model the values entered into wizard controls by the administrator.
void	setPath(String iPath) Deprecated. Sets a component path.
void	wasChanged(IWizardContext context) Deprecated. Clears all objects dependent on this object or its parent objects.

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

getControlInFocus, getDescription, getProperty, getTitle, isComplete, isMandatory, setMandatory, setProperty, setTempProperty, setupComponent

Methods inherited from class java.lang.Object

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

Field Detail

components

protected Hashtable components

Deprecated.

Returns a hashtable that is used as a container for the subcomponents.

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

WizardComponentContainer

public WizardComponentContainer()

Deprecated.

A blank constructor.

WizardComponentContainer

public WizardComponentContainer(int iLayout)

Deprecated.

A constructor that sets a layout. The layout and padding must be set at runtime.

Parameters:

iLayout - a layout

WizardComponentContainer

public WizardComponentContainer(int iLayout,
                                int iPadding)

Deprecated.

A constructor that sets a layout and padding.

Parameters:

iLayout - a layout

iPadding - padding

Method Detail

addComponent

public void addComponent(String key,
                         IWizardComponent component)

Deprecated.

Adds a specified component.

Parameters:

key - a key

component - a component

addComponent

public void addComponent(String key,
                         IWizardComponent component,
                         boolean isMandatoryField)

Deprecated.

Adds a specified wizard component and sets the component to mandatory (true).

Parameters:

key - a key

component - a component

isMandatoryField - true sets the component to mandatory

addComponent

public void addComponent(String key,
                         com.sapportals.htmlb.Component component)

Deprecated.

Adds a specified HTMLB component.

Parameters:

key - a key

component - a component

getComponent

public IWizardComponent getComponent(String key)

Deprecated.

Gets the specified component.

Specified by:

getComponent in interface IWizardComponentContainer

Parameters:

key - a key

Returns:

a component

isInitialized

public boolean isInitialized(IWizardContext context)

Deprecated.

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

Specified by:

isInitialized in interface IWizardComponent

Overrides:

isInitialized in class AbstractWizardComponent

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

Overrides:

init in class AbstractWizardComponent

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

Overrides:

doBeforeDisplay in class AbstractWizardComponent

Parameters:

context - the current wizard context

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

Overrides:

processInput in class AbstractWizardComponent

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

Overrides:

doAfterSubmit in class AbstractWizardComponent

Parameters:

context - the current wizard context

getPath

public String getPath()

Deprecated.

Gets the path of this component.

Specified by:

getPath in interface IWizardComponent

Overrides:

getPath in class AbstractWizardComponent

Returns:

the path

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

Overrides:

setPath in class AbstractWizardComponent

Parameters:

iPath - a component path

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

Overrides:

getDisplay in class AbstractWizardComponent

Parameters:

context - the current wizard context

Returns:

the component, null if the component has no display

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

Overrides:

wasChanged in class AbstractWizardComponent

Parameters:

context - the current wizard context

clearIfInconsistent

public void clearIfInconsistent(String changedObjectKey,
                                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

Overrides:

clearIfInconsistent in class AbstractWizardComponent

Parameters:

changedObjectKey - a changed object

context - the current wizard context

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

Overrides:

getErrorMessages in class AbstractWizardComponent

Parameters:

context - the current wizard context

Returns:

a list of error messages

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