com.sapportals.admin.wizardframework.components

Class MultilineInputComponent

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

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

The class that represents a multi-line 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

MultilineInputComponent()
Deprecated. A blank constructor.

MultilineInputComponent(int iColNum, int iRowNum)
Deprecated. A constructor that sets the number of columns and rows.

MultilineInputComponent(int iColNum, int iRowNum, String iDefaultCaption)
Deprecated. A constructor that sets the number of columns, rows, and a default caption.

MultilineInputComponent(int iColNum, int iRowNum, String iDefaultCaption, String iDefaultValue)
Deprecated. A constructor that sets the number of columns, rows, a default caption, and a default value.

MultilineInputComponent(int iColNum, int iRowNum, String iDefaultCaption, String iDefaultValue, int iLayout, int iPadding)
Deprecated. A constructor that sets the number of columns, rows, a default caption, a default value, a layout, and padding.

MultilineInputComponent(int iColNum, int iRowNum, String iDefaultCaption, String iDefaultValue, int iLayout, int iPadding, String iCaptionWidth)
Deprecated. A constructor that sets the number of columns, rows, a default caption, a default value, a layout, padding, and a caption width.

MultilineInputComponent(String iDefaultCaption)
Deprecated. A constructor that sets a default caption.

MultilineInputComponent(String iDefaultCaption, String iDefaultValue)
Deprecated. A constructor that sets a default caption and a default value.

Method Summary

protected com.sapportals.htmlb.Component	createInputComponent(IBasicEditingContext context) Deprecated. Creates a multiline 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 component that currently has the focus.
com.sapportals.htmlb.TextEdit	getInputComponent(IBasicEditingContext context) Deprecated. Gets the input component.
String	getValue(IBasicEditingContext context) Deprecated. Gets the current value of the component.
void	processInput(IWizardContext context) Deprecated. Saves to the data model the values entered into the control 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 components dependent on this component or its parent components.

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

clear, clearIfInconsistent, 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, init, isInitialized, isMandatory, setMandatory, setProperty, setTempProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

MultilineInputComponent

public MultilineInputComponent(int iColNum,
                               int iRowNum)

Deprecated.

A constructor that sets the number of columns and rows.

Parameters:

iColNum - a number of columns

iRowNum - a number of rows

MultilineInputComponent

public MultilineInputComponent(int iColNum,
                               int iRowNum,
                               String iDefaultCaption)

Deprecated.

A constructor that sets the number of columns, rows, and a default caption.

Parameters:

iColNum - a number of columns

iRowNum - a number of rows

iDefaultCaption - a default caption

MultilineInputComponent

public MultilineInputComponent(int iColNum,
                               int iRowNum,
                               String iDefaultCaption,
                               String iDefaultValue)

Deprecated.

A constructor that sets the number of columns, rows, a default caption, and a default value.

Parameters:

iColNum - a number of columns

iRowNum - a number of rows

iDefaultCaption - a default caption

iDefaultValue - a default value

MultilineInputComponent

public MultilineInputComponent(int iColNum,
                               int iRowNum,
                               String iDefaultCaption,
                               String iDefaultValue,
                               int iLayout,
                               int iPadding)

Deprecated.

A constructor that sets the number of columns, rows, a default caption, a default value, a layout, and padding.

Parameters:

iColNum - a number of columns

iRowNum - a number of rows

iDefaultCaption - a default caption

iDefaultValue - a default value

iLayout - a layout

iPadding - padding

MultilineInputComponent

public MultilineInputComponent(int iColNum,
                               int iRowNum,
                               String iDefaultCaption,
                               String iDefaultValue,
                               int iLayout,
                               int iPadding,
                               String iCaptionWidth)

Deprecated.

A constructor that sets the number of columns, rows, a default caption, a default value, a layout, padding, and a caption width.

Parameters:

iColNum - a number of columns

iRowNum - a number of rows

iDefaultCaption - a default caption

iDefaultValue - a default value

iLayout - a layout

iPadding - padding

iCaptionWidth - a caption width

MultilineInputComponent

public MultilineInputComponent()

Deprecated.

A blank constructor. The caption, column and row numbers, and default value must be set at runtime.

MultilineInputComponent

public MultilineInputComponent(String iDefaultCaption)

Deprecated.

A constructor that sets a default caption.

Parameters:

iDefaultCaption - a default caption

MultilineInputComponent

public MultilineInputComponent(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

Method Detail

getValue

public String getValue(IBasicEditingContext context)

Deprecated.

Gets the current value of the 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.TextEdit 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 multiline 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 the control 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 components dependent on this component or its parent components. Called whenever a component is changed.

Specified by:

wasChanged in interface IDependencyObject

Overrides:

wasChanged in class AbstractWizardComponent

Parameters:

context - the current wizard context

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:

a component object

Access Rights

This class can be accessed from:

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