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

public class TextInputComponent

extends AbstractInputComponent

Version:

6.0 implementation of a simple text input component.

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

captionWidth, DEFAULT_PADDING, defaultCaption, defaultTooltip, defaultValue, 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

TextInputComponent()
sorry, no detailed documentation yet

TextInputComponent(java.lang.String iDefaultCaption)
sorry, no detailed documentation yet

TextInputComponent(java.lang.String iDefaultCaption, java.lang.String iDefaultValue)
sorry, no detailed documentation yet

TextInputComponent(java.lang.String iDefaultCaption, java.lang.String iDefaultValue, int iLayout)
sorry, no detailed documentation yet

TextInputComponent(java.lang.String iDefaultCaption, java.lang.String iDefaultValue, int iLayout, int iPadding)
sorry, no detailed documentation yet

TextInputComponent(java.lang.String iDefaultCaption, java.lang.String iDefaultValue, int iLayout, int iPadding, java.lang.String iCaptionWidth)
sorry, no detailed documentation yet

TextInputComponent(java.lang.String iDefaultCaption, java.lang.String iDefaultValue, int iLayout, int iPadding, java.lang.String iCaptionWidth, java.lang.String iFieldWidth)
sorry, no detailed documentation yet

TextInputComponent(java.lang.String iDefaultCaption, java.lang.String iDefaultValue, int iLayout, int iPadding, java.lang.String iCaptionWidth, java.lang.String iFieldWidth, java.lang.String iTargetPath)
sorry, no detailed documentation yet

Method Summary

void	clearIfInconsistent(java.lang.String changedObject, IWizardContext ctx) the default implementtion clears all values from this component's branch in the session.
protected com.sapportals.htmlb.Component	createInputComponent(IBasicEditingContext context)
void	doAfterSubmit(IWizardContext context) the default implemention does nothing
com.sapportals.htmlb.Component	getControlInFocus(IWizardContext ctx)
com.sapportals.htmlb.InputField	getInputComponent(IBasicEditingContext context) sorry, no detailed documentation yet
java.lang.String	getValue(IBasicEditingContext context)
void	init(IWizardContext ctx) the default implemention does nothing on init
boolean	isInitialized(IWizardContext ctx) always returns true - override this function if your component needs dynamic initialization
void	processInput(IWizardContext context) Store the value from the htmlb display in the session.
void	setValue(java.lang.String newValue, IWizardContext context)
void	wasChanged(IWizardContext context) this method should be called whenever a component is changed.

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()

sorry, no detailed documentation yet

TextInputComponent

public TextInputComponent(java.lang.String iDefaultCaption)

sorry, no detailed documentation yet

Parameters:

String - iDefaultCaption

TextInputComponent

public TextInputComponent(java.lang.String iDefaultCaption,
                          java.lang.String iDefaultValue)

sorry, no detailed documentation yet

Parameters:

String - iDefaultCaption

String - iDefaultValue

TextInputComponent

public TextInputComponent(java.lang.String iDefaultCaption,
                          java.lang.String iDefaultValue,
                          int iLayout)

sorry, no detailed documentation yet

Parameters:

String - iDefaultCaption

String - iDefaultValue

int - iLayout

TextInputComponent

public TextInputComponent(java.lang.String iDefaultCaption,
                          java.lang.String iDefaultValue,
                          int iLayout,
                          int iPadding)

sorry, no detailed documentation yet

Parameters:

String - iDefaultCaption

String - iDefaultValue

int - iLayout

int - iPadding

TextInputComponent

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

sorry, no detailed documentation yet

Parameters:

String - iDefaultCaption

String - iDefaultValue

int - iLayout

int - iPadding

String - iCaptionWidth

TextInputComponent

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

sorry, no detailed documentation yet

Parameters:

String - iDefaultCaption

String - iDefaultValue

int - iLayout

int - iPadding

String - iCaptionWidth

String - iFieldWidth

TextInputComponent

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

sorry, no detailed documentation yet

Parameters:

String - iDefaultCaption

String - iDefaultValue

int - iLayout

int - iPadding

String - iCaptionWidth

String - iFieldWidth

String - ITargetPath

Method Detail

isInitialized

public boolean isInitialized(IWizardContext ctx)

Description copied from class: AbstractWizardComponent

always returns true - override this function if your component needs dynamic initialization

Overrides:

isInitialized in class AbstractWizardComponent

Following copied from interface: com.sapportals.admin.wizardframework.api.IWizardComponent

Returns:

- has this component already been initialized?

init

public void init(IWizardContext ctx)

Description copied from class: AbstractWizardComponent

the default implemention does nothing on init

Overrides:

init in class AbstractWizardComponent

getValue

public java.lang.String getValue(IBasicEditingContext context)

setValue

public void setValue(java.lang.String newValue,
                     IWizardContext context)

getInputComponent

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

sorry, no detailed documentation yet

Parameters:

context -

Returns:

createInputComponent

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

Overrides:

createInputComponent in class AbstractInputComponent

processInput

public void processInput(IWizardContext context)

Store the value from the htmlb display in the session.

Overrides:

processInput in class AbstractInputComponent

doAfterSubmit

public void doAfterSubmit(IWizardContext context)

Description copied from class: AbstractWizardComponent

the default implemention does nothing

Overrides:

doAfterSubmit in class AbstractWizardComponent

wasChanged

public void wasChanged(IWizardContext context)

Description copied from class: AbstractWizardComponent

this method should be called whenever a component is changed. It clears all components dependent on this component or its parent components.

Overrides:

wasChanged in class AbstractWizardComponent

clearIfInconsistent

public void clearIfInconsistent(java.lang.String changedObject,
                                IWizardContext ctx)

Description copied from class: AbstractWizardComponent

the default implementtion clears all values from this component's branch in the session.

Overrides:

clearIfInconsistent in class AbstractInputComponent

getControlInFocus

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

Overrides:

getControlInFocus in class AbstractWizardComponent