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

public abstract class AbstractInputComponent

extends AbstractWizardComponent

Field Summary

protected java.lang.String	captionWidth
static int	DEFAULT_PADDING
protected java.lang.String	defaultCaption
protected java.lang.String	defaultTooltip
protected java.lang.Object	defaultValue
protected boolean	filledIncompletely
static java.lang.String	INPUT_COMPONENT
protected com.sapportals.htmlb.Component	inputComponent
protected com.sapportals.htmlb.Label	label
protected int	layout
protected int	padding
static java.lang.String	VALUE
protected java.lang.String	valueTargetPath

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

HORIZONTAL_LAYOUT, VERTICAL_LAYOUT

Constructor Summary

AbstractInputComponent()

Method Summary

void	clear()
void	clearIfInconsistent(java.lang.String changedObject, IWizardContext ctx) the default implementtion clears all values from this component's branch in the session.
protected abstract com.sapportals.htmlb.Component	createInputComponent(IBasicEditingContext ctx)
java.lang.String	getCaption(IBasicEditingContext context)
com.sapportals.htmlb.Label	getCaptionComponent(IWizardContext context)
com.sapportals.htmlb.Component	getDisplay(IWizardContext context) the default implementation returns null - if your component has a display it should inherit AbstractDisplayComponent or AbstractInputComponent.
java.util.List	getErrorMessages(IWizardContext context) Get the error messages for this component.
com.sapportals.htmlb.Component	getInputComponentGeneric(IBasicEditingContext ctx)
java.lang.String	getMissingFieldErrorMessage(IBasicEditingContext context)
java.lang.String	getTooltip(IWizardContext context)
java.lang.Object	getValueGeneric(IBasicEditingContext context)
boolean	isComplete(IWizardContext ctx) the default implemention returns true
abstract void	processInput(IWizardContext ctx) the default implemention does no input processing.
void	setCaption(java.lang.String caption, IWizardContext context)
void	setCaptionWidth(java.lang.String iCaptionWidth)
void	setCustomErrorMessage(java.lang.String errorMessage) Deprecated. - use of this function will cause inconsistencies in the error handling of different wizards - it will be removed for MS1 Define the error message to be displayed if this component was not filled
void	setLayout(int iLayout)
void	setPath(java.lang.String iPath) set the path of this component. e.g. it's position in the wizard hierarchy. path components are seperated by IWizardSession.PATH_DELIMITER. example: "pane1.nameComponent.firstNameInputField".
void	setTooltip(java.lang.String tooltip, IWizardContext ctx)
void	setupComponent(IWizardContext ctx) setup the component here. if this component is a container add all subcomponents here
void	setValueGeneric(java.lang.Object newValue, IWizardContext context)
void	setValueTargetPath(java.lang.String iValueTargetPath) Set the path of the property underlying this input control

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 java.lang.String VALUE

valueTargetPath

protected java.lang.String valueTargetPath

INPUT_COMPONENT

public static final java.lang.String INPUT_COMPONENT

DEFAULT_PADDING

public static final int DEFAULT_PADDING

defaultCaption

protected java.lang.String defaultCaption

defaultTooltip

protected java.lang.String defaultTooltip

inputComponent

protected com.sapportals.htmlb.Component inputComponent

filledIncompletely

protected boolean filledIncompletely

label

protected com.sapportals.htmlb.Label label

layout

protected int layout

padding

protected int padding

captionWidth

protected java.lang.String captionWidth

defaultValue

protected java.lang.Object defaultValue

Constructor Detail

AbstractInputComponent

public AbstractInputComponent()

Method Detail

clear

public void clear()

setupComponent

public void setupComponent(IWizardContext ctx)

Description copied from interface: IWizardComponent

setup the component here. if this component is a container add all subcomponents here

Overrides:

setupComponent in class AbstractWizardComponent

getValueGeneric

public java.lang.Object getValueGeneric(IBasicEditingContext context)

setValueGeneric

public void setValueGeneric(java.lang.Object newValue,
                            IWizardContext context)

setPath

public void setPath(java.lang.String iPath)

Description copied from class: AbstractWizardComponent

set the path of this component. e.g. it's position in the wizard hierarchy. path components are seperated by IWizardSession.PATH_DELIMITER. example: "pane1.nameComponent.firstNameInputField". If this component contains other components it will set their path in this function.

Overrides:

setPath in class AbstractWizardComponent

setValueTargetPath

public void setValueTargetPath(java.lang.String iValueTargetPath)

Set the path of the property underlying this input control

Parameters:

valueTargetPath - the path of this control's value in the session

getCaption

public java.lang.String getCaption(IBasicEditingContext context)

getTooltip

public java.lang.String getTooltip(IWizardContext context)

setCaption

public void setCaption(java.lang.String caption,
                       IWizardContext context)

setTooltip

public void setTooltip(java.lang.String tooltip,
                       IWizardContext ctx)

getCaptionComponent

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

getInputComponentGeneric

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

getDisplay

public com.sapportals.htmlb.Component getDisplay(IWizardContext context)

Description copied from class: AbstractWizardComponent

the default implementation returns null - if your component has a display it should inherit AbstractDisplayComponent or AbstractInputComponent.

Overrides:

getDisplay in class AbstractWizardComponent

setLayout

public void setLayout(int iLayout)

setCustomErrorMessage

public void setCustomErrorMessage(java.lang.String errorMessage)

Deprecated. - use of this function will cause inconsistencies in the error handling of different wizards - it will be removed for MS1 Define the error message to be displayed if this component was not filled

getMissingFieldErrorMessage

public java.lang.String getMissingFieldErrorMessage(IBasicEditingContext context)

getErrorMessages

public java.util.List getErrorMessages(IWizardContext context)

Get the error messages for this component.

Overrides:

getErrorMessages in class AbstractWizardComponent

Returns:

the list of error messages for this component or null if the component was filled properly

setCaptionWidth

public void setCaptionWidth(java.lang.String iCaptionWidth)

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 AbstractWizardComponent

isComplete

public boolean isComplete(IWizardContext ctx)

Description copied from class: AbstractWizardComponent

the default implemention returns true

Overrides:

isComplete in class AbstractWizardComponent

createInputComponent

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

processInput

public abstract void processInput(IWizardContext ctx)

Description copied from class: AbstractWizardComponent

the default implemention does no input processing.

Overrides:

processInput in class AbstractWizardComponent