com.sapportals.admin.wizardframework.components

Class GridContainer

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

All Implemented Interfaces:

IDependencyObject, IWizardComponent, IWizardComponentContainer

Direct Known Subclasses:

InfoPane, MultiSelectionComponent, SummaryPane

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

public class GridContainer
extends AbstractWizardComponent
implements IWizardComponentContainer

The class that represents a container grid. A grid is a two dimensional arrangement of data in rows and columns.

Field Summary

protected String

GRID Deprecated. A constant that indicates the grid.

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

HORIZONTAL_LAYOUT, VERTICAL_LAYOUT

Constructor Summary

GridContainer()
Deprecated. A blank constructor.

GridContainer(int iPadding)
Deprecated. A constructor that sets padding.

GridContainer(int iPadding, String iWidth, String iHeight)
Deprecated. A constructor that sets the padding, width and height.

Method Summary

void	addComponent(String key, com.sapportals.htmlb.Component component, int line, int column) Deprecated. Adds a component specified by a key to the specified line and column in the grid.
void	addComponent(String key, IWizardComponent component, int line, int column, boolean isMandatoryField) Deprecated. Adds a component specified by a key, to the specified line and column in the grid, 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 on each subcomponent.
protected void	delegateSetupComponent(IWizardContext context) Deprecated. Performs setupComponent(com.sapportals.admin.wizardframework.api.IWizardContext) on each subcomponent.
void	doAfterSubmit(IWizardContext context) Deprecated. Performs any actions on the data after user input is collected.
void	doBeforeDisplay(IWizardContext context) Deprecated. Performs synchronization between the data model and the pane.
com.sapportals.htmlb.GridLayoutCell	getCell(int row, int column, IWizardContext ctx) Deprecated. Gets the cell object in this container specified by the row and column.
IWizardComponent	getComponent(String key) Deprecated. Gets the component specified by a key.
com.sapportals.htmlb.Component	getControlInFocus(IWizardContext ctx) Deprecated. Gets the component that currently has the focus.
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.
com.sapportals.htmlb.GridLayout	getGrid(IWizardContext ctx) Deprecated. Gets the grid layout object for this container.
String	getPath() Deprecated. Gets the path of a 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. Sets the values of the HTMLB controls in the pane based on the data model.
protected void	myProcessInput(IWizardContext ctx) Deprecated. Saves to the data model the data from any 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	setSize(String iWidth, String iHeight) Deprecated. Sets the width and height of a container.
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

Field Detail

GRID

protected final String GRID

Deprecated.

A constant that indicates the grid.

See Also:

Constant Field Values

Constructor Detail

GridContainer

public GridContainer()

Deprecated.

A blank constructor.

GridContainer

public GridContainer(int iPadding)

Deprecated.

A constructor that sets padding.

Parameters:

iPadding - padding

GridContainer

public GridContainer(int iPadding,
                     String iWidth,
                     String iHeight)

Deprecated.

A constructor that sets the padding, width and height. If the content size exceeds the container, the content is scrolled.

Parameters:

iPadding - padding

iWidth - a width

iHeight - a height

Method Detail

setSize

public void setSize(String iWidth,
                    String iHeight)

Deprecated.

Sets the width and height of a container.

Parameters:

iWidth - a width

iHeight - a height

addComponent

public final void addComponent(String key,
                               com.sapportals.htmlb.Component component,
                               int line,
                               int column)

Deprecated.

Adds a component specified by a key to the specified line and column in the grid.

Parameters:

key - a key

component - a com.sapportals.htmlb.Component component

line - a line number

column - a column number

addComponent

public final void addComponent(String key,
                               IWizardComponent component,
                               int line,
                               int column,
                               boolean isMandatoryField)

Deprecated.

Adds a component specified by a key, to the specified line and column in the grid, and sets the component to mandatory.

Parameters:

key - a key

component - a component

line - a line number

column - a column number

isMandatoryField - true sets the component to mandatory

getComponent

public final IWizardComponent getComponent(String key)

Deprecated.

Gets the component specified by a key.

Specified by:

getComponent in interface IWizardComponentContainer

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.

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

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.

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 on each subcomponent.

Parameters:

ctx - the current wizard context

myProcessInput

protected void myProcessInput(IWizardContext ctx)

Deprecated.

Saves to the data model the data from any 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 after user input is collected. The input data must be valid.

Specified by:

doAfterSubmit in interface IWizardComponent

Overrides:

doAfterSubmit in class AbstractWizardComponent

Parameters:

context - the current wizard context

getPath

public final String getPath()

Deprecated.

Gets the path of a component.

Specified by:

getPath in interface IWizardComponent

Overrides:

getPath in class AbstractWizardComponent

Returns:

the path

setPath

public final void setPath(String iPath)

Deprecated.

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

Specified by:

setPath in interface IWizardComponent

Overrides:

setPath in class AbstractWizardComponent

Parameters:

iPath - a container path

getGrid

public final com.sapportals.htmlb.GridLayout getGrid(IWizardContext ctx)

Deprecated.

Gets the grid layout object for this container.

Parameters:

ctx - the current wizard context

Returns:

the grid layout

getCell

public final com.sapportals.htmlb.GridLayoutCell getCell(int row,
                                                         int column,
                                                         IWizardContext ctx)

Deprecated.

Gets the cell object in this container specified by the row and column.

Parameters:

row - a row number

column - a column number

ctx - the current wizard context

Returns:

a cell

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

getControlInFocus

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

Deprecated.

Gets the component that currently has the focus.

Specified by:

getControlInFocus in interface IWizardComponent

Overrides:

getControlInFocus in class AbstractWizardComponent

Parameters:

ctx - the current wizard context

Returns:

the component

Access Rights

This class can be accessed from:

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