com.sapportals.admin.wizardframework.components
Class MultiSelectionComponent

java.lang.Object
  |
  +--com.sapportals.admin.wizardframework.components.AbstractWizardComponent
        |
        +--com.sapportals.admin.wizardframework.components.GridContainer
              |
              +--com.sapportals.admin.wizardframework.components.MultiSelectionComponent

All Implemented Interfaces:

IDependencyObject, IWizardComponent, IWizardComponentContainer

public class MultiSelectionComponent

extends GridContainer

Field Summary

static java.lang.String	VALUE
static java.lang.String	VALUE_TITLES

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

GRID

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

HORIZONTAL_LAYOUT, VERTICAL_LAYOUT

Constructor Summary

MultiSelectionComponent(java.lang.String iPathOfListToChooseFrom, int iWidth)
Sorry, no documentation comment here

MultiSelectionComponent(java.lang.String iPathOfListToChooseFrom, int iWidth, int iHeight)
Deprecated.

MultiSelectionComponent(java.lang.String iPathOfListToChooseFrom, int iWidth, int iHeight, java.lang.String iChoiceCaption, java.lang.String iSelectionCaption)
Deprecated.

MultiSelectionComponent(java.lang.String iPathOfListToChooseFrom, int iWidth, java.lang.String iChoiceCaption, java.lang.String iSelectionCaption)
Sorry, no documentation comment here

MultiSelectionComponent(java.lang.String iPathOfListToChooseFrom, java.lang.String iPathOfChoiceTitles, int iWidth, int iHeight, java.lang.String iChoiceCaption, java.lang.String iSelectionCaption)
Deprecated.

MultiSelectionComponent(java.lang.String iPathOfListToChooseFrom, java.lang.String iPathOfChoiceTitles, int iWidth, java.lang.String iChoiceCaption, java.lang.String iSelectionCaption)
Sorry, no documentation comment here

Method Summary

void	clearIfInconsistent(java.lang.String changedObjectKey, IWizardContext ctx) the default implementtion clears all values from this component's branch in the session.
void	doAfterProcess(IWizardContext ctx)
com.sapportals.htmlb.Component	getDisplay(IWizardContext ctx) Sorry, no documentation comment here
java.util.List	getErrorMessages(IWizardContext context) Get the error messages for this component.
boolean	isComplete(IWizardContext context) the default implemention returns true
void	myProcessInput(IWizardContext ctx) Store the value from the htmlb display in the session.
void	mySetupComponent(IWizardContext ctx)
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 Sorry, no documentation comment here
void	setDefaultValue(java.util.List defaultValue)

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

addComponent, addComponent, delegateDoBeforeDisplay, delegateProcessInput, delegateSetupComponent, doAfterSubmit, doBeforeDisplay, getCell, getComponent, getControlInFocus, getGrid, getPath, init, isInitialized, myDoBeforeDisplay, processInput, setPath, setSize, setupComponent, wasChanged

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

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

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

VALUE_TITLES

public static final java.lang.String VALUE_TITLES

Constructor Detail

MultiSelectionComponent

public MultiSelectionComponent(java.lang.String iPathOfListToChooseFrom,
                               int iWidth,
                               int iHeight)

Deprecated.

Parameters:

String - iPathOfListToChooseFrom

int - iWidth

int - iHeight

MultiSelectionComponent

public MultiSelectionComponent(java.lang.String iPathOfListToChooseFrom,
                               int iWidth,
                               int iHeight,
                               java.lang.String iChoiceCaption,
                               java.lang.String iSelectionCaption)

Deprecated.

Parameters:

String - iPathOfListToChooseFrom

int - iWidth

int - iHeight

String - iChoiceCaption

String - iSelectionCaption

MultiSelectionComponent

public MultiSelectionComponent(java.lang.String iPathOfListToChooseFrom,
                               java.lang.String iPathOfChoiceTitles,
                               int iWidth,
                               int iHeight,
                               java.lang.String iChoiceCaption,
                               java.lang.String iSelectionCaption)

Deprecated.

Parameters:

String - iPathOfListToChooseFrom

String - iPathOfChoiceTitles

int - iWidth

int - iHeight

String - iChoiceCaption

String - iSelectionCaption

MultiSelectionComponent

public MultiSelectionComponent(java.lang.String iPathOfListToChooseFrom,
                               int iWidth)

Sorry, no documentation comment here

Parameters:

String - iPathOfListToChooseFrom

int - iWidth

MultiSelectionComponent

public MultiSelectionComponent(java.lang.String iPathOfListToChooseFrom,
                               int iWidth,
                               java.lang.String iChoiceCaption,
                               java.lang.String iSelectionCaption)

Sorry, no documentation comment here

Parameters:

String - iPathOfListToChooseFrom

int - iWidth

String - iChoiceCaption

String - iSelectionCaption

MultiSelectionComponent

public MultiSelectionComponent(java.lang.String iPathOfListToChooseFrom,
                               java.lang.String iPathOfChoiceTitles,
                               int iWidth,
                               java.lang.String iChoiceCaption,
                               java.lang.String iSelectionCaption)

Sorry, no documentation comment here

Parameters:

String - iPathOfListToChooseFrom

String - iPathOfChoiceTitles

int - iWidth

String - iChoiceCaption

String - iSelectionCaption

Method Detail

mySetupComponent

public void mySetupComponent(IWizardContext ctx)

Overrides:

mySetupComponent in class GridContainer

setDefaultValue

public void setDefaultValue(java.util.List defaultValue)

getDisplay

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

Sorry, no documentation comment here

Overrides:

getDisplay in class GridContainer

Parameters:

ctx - public void myDoBeforeDisplay (IWizardContext ctx) { //context.log("choices:"+ctx.getProperty(this.pathOfListToChooseFrom)); //context.log("titles:"+ctx.getProperty(this.pathOfChoiceTitles)); if (getProperty(VALUE, ctx) == null) { this.setProperty(VALUE, new StoreableList(), ctx); } if (getProperty(VALUE_TITLES, ctx) == null) { this.setProperty(VALUE_TITLES, new StoreableList(), ctx); //context.log("SEEE:"+getProperty(VALUE_TITLES,ctx)); } //super.doBeforeDisplay(ctx); }

myProcessInput

public void myProcessInput(IWizardContext ctx)

Store the value from the htmlb display in the session.

Overrides:

myProcessInput in class GridContainer

doAfterProcess

public void doAfterProcess(IWizardContext ctx)

isComplete

public boolean isComplete(IWizardContext context)

Description copied from class: AbstractWizardComponent

the default implemention returns true

Overrides:

isComplete in class AbstractWizardComponent

getErrorMessages

public java.util.List getErrorMessages(IWizardContext context)

Get the error messages for this component.

Overrides:

getErrorMessages in class GridContainer

Returns:

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

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 Sorry, no documentation comment here

Parameters:

errorMessage -

clearIfInconsistent

public void clearIfInconsistent(java.lang.String changedObjectKey,
                                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 GridContainer