com.sapportals.admin.wizardframework.components

Class AlignedInputComponentList

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

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 AlignedInputComponentList
extends AbstractWizardComponent

The class that represents an aligned input component list.

Field Summary

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

HORIZONTAL_LAYOUT, VERTICAL_LAYOUT

Constructor Summary

AlignedInputComponentList()
Deprecated. A blank constructor.

AlignedInputComponentList(int iPadding)
Deprecated. A constructor that sets the padding.

Method Summary

void	addComponent(String key, AbstractInputComponent component) Deprecated. Adds a component with the specified key.
void	addComponent(String key, AbstractInputComponent component, boolean isMandatoryField) Deprecated. Adds a component with the specified key and sets the component to mandatory.
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.
protected void	delegateDoBeforeDisplay(IWizardContext context) Deprecated. Performs doBeforeDisplay(com.sapportals.admin.wizardframework.api.IWizardContext) on each subcomponent.
protected void	delegateProcessInput(IWizardContext ctx) Deprecated. Performs processInput(com.sapportals.admin.wizardframework.api.IWizardContext) on each subcomponent.
protected void	delegateSetupComponent(IWizardContext context) Deprecated. Sets the subcomponents.
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.
AbstractInputComponent	getComponent(String key) Deprecated. Gets the component with the specified key.
com.sapportals.htmlb.Component	getControlInFocus(IWizardContext ctx) Deprecated. Gets the control that currently has the focus.
com.sapportals.htmlb.Component	getDisplay(IWizardContext context) Deprecated. Gets the HTMLB component to diplay.
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 the component is initialized.
protected void	myDoBeforeDisplay(IWizardContext ctx) Deprecated. Performs any initialization before the pane is displayed.
protected void	myProcessInput(IWizardContext ctx) Deprecated. Saves to the data model the data from HTMLB controls created in the pane.
protected void	mySetupComponent(IWizardContext context) Deprecated. Implement this method to create your own setup for a component.
void	processInput(IWizardContext ctx) 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	setupComponent(IWizardContext context) Deprecated. Configures a component.
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

getDescription, getProperty, getTitle, 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

AlignedInputComponentList

public AlignedInputComponentList()

Deprecated.

A blank constructor.

AlignedInputComponentList

public AlignedInputComponentList(int iPadding)

Deprecated.

A constructor that sets the padding.

Parameters:

iPadding - padding

Method Detail

addComponent

public void addComponent(String key,
                         AbstractInputComponent component)

Deprecated.

Adds a component with the specified key.

Parameters:

key - a key

component - a component

addComponent

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

Deprecated.

Adds a component with the specified key and sets the component to mandatory.

Parameters:

key - a key

component - a component

isMandatoryField - true sets the component to mandatory

getComponent

public AbstractInputComponent getComponent(String key)

Deprecated.

Gets the component with the specified key.

Parameters:

key - a key

Returns:

a component

setupComponent

public void setupComponent(IWizardContext context)

Deprecated.

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

Specified by:

setupComponent in interface IWizardComponent

Overrides:

setupComponent in class AbstractWizardComponent

Parameters:

context - the current wizard context

delegateSetupComponent

protected void delegateSetupComponent(IWizardContext context)

Deprecated.

Sets the subcomponents.

Parameters:

context - the current wizard context

mySetupComponent

protected void mySetupComponent(IWizardContext context)

Deprecated.

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

Parameters:

context - the current wizard context

isInitialized

public boolean isInitialized(IWizardContext context)

Deprecated.

Indicates whether the 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

delegateDoBeforeDisplay

protected void delegateDoBeforeDisplay(IWizardContext context)

Deprecated.

Performs doBeforeDisplay(com.sapportals.admin.wizardframework.api.IWizardContext) on each subcomponent.

Parameters:

context - the current wizard context

myDoBeforeDisplay

protected void myDoBeforeDisplay(IWizardContext ctx)

Deprecated.

Performs any initialization before the pane is displayed. For example, sets the values of the HTMLB controls in the pane based on the data model.

Parameters:

ctx - the current wizard context

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

delegateProcessInput

protected void delegateProcessInput(IWizardContext ctx)

Deprecated.

Performs processInput(com.sapportals.admin.wizardframework.api.IWizardContext) on each subcomponent.

Parameters:

ctx - the current wizard context

myProcessInput

protected void myProcessInput(IWizardContext ctx)

Deprecated.

Saves to the data model the data from HTMLB controls created in the pane.

Parameters:

ctx - 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 diplay. It should inherit AbstractDisplayComponent or AbstractInputComponent.

Specified by:

getDisplay in interface IWizardComponent

Overrides:

getDisplay in class AbstractWizardComponent

Parameters:

context - the current wizard context

Returns:

the component, null if the 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

getControlInFocus

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

Deprecated.

Gets the control that currently has the focus.

Specified by:

getControlInFocus in interface IWizardComponent

Overrides:

getControlInFocus in class AbstractWizardComponent

Parameters:

ctx - the current wizard context

Returns:

a component

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