com.sapportals.admin.wizardframework.components

Class AbstractInputComponent

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

All Implemented Interfaces:

IDependencyObject, IWizardComponent

Direct Known Subclasses:

AbstractInputComponent, AbstractSelectionComponent, CheckboxChoiceComponent, MultilineInputComponent, TableViewComponent, TextInputComponent

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

public abstract class AbstractInputComponent
extends AbstractWizardComponent

The base class that is a wrapper for an input component that is not supported by the framework.

Field Summary

protected String	captionWidth Deprecated. A constant that defines the caption width.
static int	DEFAULT_PADDING Deprecated. A constant that indicates the default padding.
protected String	defaultCaption Deprecated. A constant that defines the default caption.
protected String	defaultTooltip Deprecated. A constant that defines the tooltip.
protected Object	defaultValue Deprecated. A constant that defines a default value.
protected boolean	filledIncompletely Deprecated. A constant that defines that a component was filled.
static String	INPUT_COMPONENT Deprecated. A constant that indicates the input component.
protected com.sapportals.htmlb.Component	inputComponent Deprecated. A constant that defines the input component.
protected com.sapportals.htmlb.Label	label Deprecated. A constant that defines the label.
protected int	layout Deprecated. A constant that defines the vertical layout.
protected int	padding Deprecated. A constant that defines the padding.
static String	VALUE Deprecated. A constant that indicates a value.
protected String	valueTargetPath Deprecated. A constant that indicates the target path.

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

HORIZONTAL_LAYOUT, VERTICAL_LAYOUT

Constructor Summary

AbstractInputComponent()
Deprecated.

Method Summary

void	clear() Deprecated. Removes an input component.
void	clearIfInconsistent(String changedObject, IWizardContext ctx) Deprecated. Clears all values from the component and its subtree when the object this object depends on was changed.
protected abstract com.sapportals.htmlb.Component	createInputComponent(IBasicEditingContext ctx) Deprecated. Creates an input component.
String	getCaption(IBasicEditingContext context) Deprecated. Gets the caption for a component.
com.sapportals.htmlb.Label	getCaptionComponent(IWizardContext context) Deprecated. Gets the HTMLB label for an input 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.
com.sapportals.htmlb.Component	getInputComponentGeneric(IBasicEditingContext ctx) Deprecated. Gets the input component.
String	getMissingFieldErrorMessage(IBasicEditingContext context) Deprecated. Gets the error message when a component is not filled.
String	getTooltip(IWizardContext context) Deprecated. Gets the tooltip for a component.
Object	getValueGeneric(IBasicEditingContext context) Deprecated. Gets the value of a component.
boolean	isComplete(IWizardContext ctx) Deprecated. Indicates whether there is input in the component (true).
abstract void	processInput(IWizardContext ctx) Deprecated. Saves to the data model the values entered into wizard controls by the administrator.
void	setCaption(String caption, IWizardContext context) Deprecated. Sets a caption for a component.
void	setCaptionWidth(String iCaptionWidth) Deprecated. Sets a caption width for a component.
void	setCustomErrorMessage(String errorMessage) Deprecated. using this function causes inconsistencies in the error handling of different wizards, it will be removed for MS1
void	setLayout(int iLayout) Deprecated. Sets a layout for a component.
void	setPath(String iPath) Deprecated. Sets the path for a component.
void	setTooltip(String tooltip, IWizardContext ctx) Deprecated. Sets a tooltip for a component.
void	setupComponent(IWizardContext ctx) Deprecated. Configures a component.
void	setValueGeneric(Object newValue, IWizardContext context) Deprecated. Sets the value for a component.
void	setValueTargetPath(String iValueTargetPath) Deprecated. Sets the path that points to the value of the component.

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

doAfterSubmit, doBeforeDisplay, getControlInFocus, getDescription, getPath, getProperty, getTitle, init, isInitialized, isMandatory, setMandatory, setProperty, setTempProperty, wasChanged

Methods inherited from class java.lang.Object

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

Field Detail

VALUE

public static final String VALUE

Deprecated.

A constant that indicates a value.
value

See Also:

Constant Field Values

valueTargetPath

protected String valueTargetPath

Deprecated.

A constant that indicates the target path.
null

INPUT_COMPONENT

public static final String INPUT_COMPONENT

Deprecated.

A constant that indicates the input component.
input_component

See Also:

Constant Field Values

DEFAULT_PADDING

public static final int DEFAULT_PADDING

Deprecated.

A constant that indicates the default padding.
2

See Also:

Constant Field Values

defaultCaption

protected String defaultCaption

Deprecated.

A constant that defines the default caption.

defaultTooltip

protected String defaultTooltip

Deprecated.

A constant that defines the tooltip.

inputComponent

protected com.sapportals.htmlb.Component inputComponent

Deprecated.

A constant that defines the input component.

filledIncompletely

protected boolean filledIncompletely

Deprecated.

A constant that defines that a component was filled.
false

label

protected com.sapportals.htmlb.Label label

Deprecated.

A constant that defines the label.

layout

protected int layout

Deprecated.

A constant that defines the vertical layout.
VERTICAL_LAYOUT

padding

protected int padding

Deprecated.

A constant that defines the padding.
DEFAULT_PADDING

captionWidth

protected String captionWidth

Deprecated.

A constant that defines the caption width.

defaultValue

protected Object defaultValue

Deprecated.

A constant that defines a default value.

Constructor Detail

AbstractInputComponent

public AbstractInputComponent()

Deprecated.

Method Detail

clear

public void clear()

Deprecated.

Removes an input component.

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

Overrides:

setupComponent in class AbstractWizardComponent

Parameters:

ctx - the current wizard context

getValueGeneric

public Object getValueGeneric(IBasicEditingContext context)

Deprecated.

Gets the value of a component.

Parameters:

context - the current editing context

Returns:

the value, if null, gets the default value

setValueGeneric

public void setValueGeneric(Object newValue,
                            IWizardContext context)

Deprecated.

Sets the value for a component.

Parameters:

newValue - a new value

context - the current wizard context

setPath

public void setPath(String iPath)

Deprecated.

Sets the path for a component. 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 path

setValueTargetPath

public void setValueTargetPath(String iValueTargetPath)

Deprecated.

Sets the path that points to the value of the component. Synchronizes a user interface control with a specific item in the data model and passes the name of the data model item that stores the control�s value.

Parameters:

iValueTargetPath - a path

getCaption

public String getCaption(IBasicEditingContext context)

Deprecated.

Gets the caption for a component.

Parameters:

context - the current editing context

Returns:

the caption

getTooltip

public String getTooltip(IWizardContext context)

Deprecated.

Gets the tooltip for a component.

Parameters:

context - the current wizard context

Returns:

the tootip

setCaption

public void setCaption(String caption,
                       IWizardContext context)

Deprecated.

Sets a caption for a component.

Parameters:

caption - a caption

context - the current wizard context

setTooltip

public void setTooltip(String tooltip,
                       IWizardContext ctx)

Deprecated.

Sets a tooltip for a component.

Parameters:

tooltip - a tooltip

ctx - the current wizard context

getCaptionComponent

public com.sapportals.htmlb.Label getCaptionComponent(IWizardContext context)

Deprecated.

Gets the HTMLB label for an input component. You may modify this HTMLB component (change font size, color etc). by overriding getDisplay to define a different component layout.

Parameters:

context - the current wizard context

Returns:

the input component label

getInputComponentGeneric

public com.sapportals.htmlb.Component getInputComponentGeneric(IBasicEditingContext ctx)

Deprecated.

Gets the input component.

Parameters:

ctx - the current editing context

Returns:

the input component

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

setLayout

public void setLayout(int iLayout)

Deprecated.

Sets a layout for a component.

Parameters:

iLayout - a layout

setCustomErrorMessage

public void setCustomErrorMessage(String errorMessage)

Deprecated. using this function causes inconsistencies in the error handling of different wizards, it will be removed for MS1

Sets a custom error message to display if a component is not filled.

Parameters:

errorMessage - an error message

getMissingFieldErrorMessage

public String getMissingFieldErrorMessage(IBasicEditingContext context)

Deprecated.

Gets the error message when a component is not filled.

Parameters:

context - the current editing context

Returns:

the error message

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

setCaptionWidth

public void setCaptionWidth(String iCaptionWidth)

Deprecated.

Sets a caption width for a component.

Parameters:

iCaptionWidth - a width

clearIfInconsistent

public void clearIfInconsistent(String changedObject,
                                IWizardContext ctx)

Deprecated.

Clears all values from the component and its subtree when the object this object depends on was changed. You should clear any values in the pane that depend on the changed object.
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:

changedObject - a changed object

ctx - the current wizard context

isComplete

public boolean isComplete(IWizardContext ctx)

Deprecated.

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

Overrides:

isComplete in class AbstractWizardComponent

Parameters:

ctx - the current wizard context

Returns:

true if there is input, false no input

createInputComponent

protected abstract com.sapportals.htmlb.Component createInputComponent(IBasicEditingContext ctx)

Deprecated.

Creates an input component.

Parameters:

ctx - the current editing context

Returns:

the component object

processInput

public abstract 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

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