com.sapportals.admin.wizardframework.components

Class TextInputComponent

java.lang.Object

com.sapportals.admin.wizardframework.components.AbstractWizardComponent

com.sapportals.admin.wizardframework.components.AbstractInputComponent

com.sapportals.admin.wizardframework.components.TextInputComponent

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 TextInputComponent
extends AbstractInputComponent

A class that represents a text input component.

Field Summary

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

captionWidth, DEFAULT_PADDING, defaultCaption, defaultTooltip, filledIncompletely, INPUT_COMPONENT, inputComponent, label, layout, padding, VALUE, valueTargetPath

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

HORIZONTAL_LAYOUT, VERTICAL_LAYOUT

Constructor Summary

Constructors

Constructor and Description
TextInputComponent() Deprecated. A blank constructor.
TextInputComponent(String iDefaultCaption) Deprecated. A constructor that sets a default caption.
TextInputComponent(String iDefaultCaption, String iDefaultValue) Deprecated. A constructor that sets a default caption and a default value.
TextInputComponent(String iDefaultCaption, String iDefaultValue, int iLayout) Deprecated. A constructor that sets a default caption, a default value and a layout.
TextInputComponent(String iDefaultCaption, String iDefaultValue, int iLayout, int iPadding) Deprecated. A constructor that sets a default caption, a default value, a layout and padding.
TextInputComponent(String iDefaultCaption, String iDefaultValue, int iLayout, int iPadding, String iCaptionWidth) Deprecated. A constructor that sets a default caption, a default value, a layout and padding, and a caption width.
TextInputComponent(String iDefaultCaption, String iDefaultValue, int iLayout, int iPadding, String iCaptionWidth, String iFieldWidth) Deprecated. A constructor that sets a default caption, a default value, a layout and padding, a caption width and a field width.
TextInputComponent(String iDefaultCaption, String iDefaultValue, int iLayout, int iPadding, String iCaptionWidth, String iFieldWidth, String iTargetPath) Deprecated. A constructor that sets a default caption, a default value, a layout and padding, a caption width, a field width and a target path.

Method Summary

Modifier and Type	Method and Description
void	clearIfInconsistent(String changedObject, IWizardContext ctx) Deprecated. Clears all values from the object and its subtree when the object this object depends on was changed.
protected com.sapportals.htmlb.Component	createInputComponent(IBasicEditingContext context) Deprecated. Creates a text input component.
void	doAfterSubmit(IWizardContext context) Deprecated. Performs any actions on the data if the data is valid.
com.sapportals.htmlb.Component	getControlInFocus(IWizardContext ctx) Deprecated. Gets the control that currently has the focus.
com.sapportals.htmlb.InputField	getInputComponent(IBasicEditingContext context) Deprecated. Gets the input component.
String	getValue(IBasicEditingContext context) Deprecated. Gets the current value of a component.
void	init(IWizardContext ctx) Deprecated. Implement this method to initialize a component.
boolean	isInitialized(IWizardContext ctx) Deprecated. Indicates whether the component is initialized.
void	processInput(IWizardContext context) Deprecated. Saves to the data model the values entered into wizard controls by the administrator.
void	setValue(String newValue, IWizardContext context) Deprecated. Sets the component value to the specified value.
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.AbstractInputComponent

clear, getCaption, getCaptionComponent, getDisplay, getErrorMessages, getInputComponentGeneric, getMissingFieldErrorMessage, getTooltip, getValueGeneric, isComplete, setCaption, setCaptionWidth, setCustomErrorMessage, setLayout, setPath, setTooltip, setupComponent, setValueGeneric, setValueTargetPath

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

doBeforeDisplay, getDescription, getPath, getProperty, getTitle, isMandatory, setMandatory, setProperty, setTempProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

TextInputComponent

public TextInputComponent()

Deprecated.

A blank constructor. The caption, and default values must be set at runtime.

TextInputComponent

public TextInputComponent(String iDefaultCaption)

Deprecated.

A constructor that sets a default caption.

Parameters:

iDefaultCaption - a default caption

TextInputComponent

public TextInputComponent(String iDefaultCaption,
                          String iDefaultValue)

Deprecated.

A constructor that sets a default caption and a default value.

Parameters:

iDefaultCaption - a default caption

iDefaultValue - a default value

TextInputComponent

public TextInputComponent(String iDefaultCaption,
                          String iDefaultValue,
                          int iLayout)

Deprecated.

A constructor that sets a default caption, a default value and a layout.

Parameters:

iDefaultCaption - a default caption

iDefaultValue - a default value

iLayout - a layout

TextInputComponent

public TextInputComponent(String iDefaultCaption,
                          String iDefaultValue,
                          int iLayout,
                          int iPadding)

Deprecated.

A constructor that sets a default caption, a default value, a layout and padding.

Parameters:

iDefaultCaption - a default caption

iDefaultValue - a default value

iLayout - a layout

iPadding - padding

TextInputComponent

public TextInputComponent(String iDefaultCaption,
                          String iDefaultValue,
                          int iLayout,
                          int iPadding,
                          String iCaptionWidth)

Deprecated.

A constructor that sets a default caption, a default value, a layout and padding, and a caption width.

Parameters:

iDefaultCaption - a default caption

iDefaultValue - a default value

iLayout - a layout

iPadding - padding

iCaptionWidth - a caption width

TextInputComponent

public TextInputComponent(String iDefaultCaption,
                          String iDefaultValue,
                          int iLayout,
                          int iPadding,
                          String iCaptionWidth,
                          String iFieldWidth)

Deprecated.

A constructor that sets a default caption, a default value, a layout and padding, a caption width and a field width.

Parameters:

iDefaultCaption - a default caption

iDefaultValue - a default value

iLayout - a layout

iPadding - padding

iCaptionWidth - a caption width

iFieldWidth - a field width

TextInputComponent

public TextInputComponent(String iDefaultCaption,
                          String iDefaultValue,
                          int iLayout,
                          int iPadding,
                          String iCaptionWidth,
                          String iFieldWidth,
                          String iTargetPath)

Deprecated.

A constructor that sets a default caption, a default value, a layout and padding, a caption width, a field width and a target path.

Parameters:

iDefaultCaption - a default caption

iDefaultValue - a default value

iLayout - a layout

iPadding - padding

iCaptionWidth - a caption width

iFieldWidth - a field width

iTargetPath - a target path

Method Detail

isInitialized

public boolean isInitialized(IWizardContext ctx)

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:

ctx - the current wizard context

Returns:

true

init

public void init(IWizardContext ctx)

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:

ctx - the current wizard context

getValue

public String getValue(IBasicEditingContext context)

Deprecated.

Gets the current value of a component.

Parameters:

context - the current editing context

Returns:

the current value of this component

setValue

public void setValue(String newValue,
                     IWizardContext context)

Deprecated.

Sets the component value to the specified value.

Parameters:

newValue - a value for the component

context - the current wizard context

getInputComponent

public com.sapportals.htmlb.InputField getInputComponent(IBasicEditingContext context)

Deprecated.

Gets the input component. Returns the same component in the same request. If this HTMLB component is modified (for example, change its graphic appearance, define client events, etc) before it is displayed, it affects the component when it is displayed by the getDisplay function.
Use this HTMLB component if you override getDisplay to define a different component layout.

Parameters:

context - the current editing context

Returns:

the input component

createInputComponent

protected com.sapportals.htmlb.Component createInputComponent(IBasicEditingContext context)

Deprecated.

Creates a text input component.

Specified by:

createInputComponent in class AbstractInputComponent

Parameters:

context - the current editing context

Returns:

the component object

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

Specified by:

processInput in class AbstractInputComponent

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

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 changedObject,
                                IWizardContext ctx)

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 AbstractInputComponent

Parameters:

changedObject - a changed object

ctx - the current wizard context

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:

the component