com.sapportals.admin.wizardframework.components

Class AbstractSelectionComponent

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

All Implemented Interfaces:

IDependencyObject, IWizardComponent

Direct Known Subclasses:

CheckboxSelectionComponent, DropdownSelectionComponent, ListSelectionComponent, RadioButtonSelectionComponent

public abstract class AbstractSelectionComponent

extends AbstractInputComponent

Field Summary

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

protected

AbstractSelectionComponent(String iDefaultCaption, boolean iIsMultiValue, List iDefaultChoiceList, List iDefaultChoiceTitleList, List iDefaultChoiceTooltipList, String iChoiceListPath, String iChoiceTitleListPath, String iChoiceTooltipListPath, String iDefaultSingleValue, List iDefaultMultiValue)

Method Summary

protected Component	createCheckboxGroupInputComponent(IBasicEditingContext context)
protected Component	createDropDownInputComponent(IBasicEditingContext context)
protected Component	createListBoxInputComponent(IBasicEditingContext context)
protected Component	createRadioButtonInputComponent(IBasicEditingContext context)
protected List	getCheckboxGroupValuesFromForm(IWizardContext context)
List	getChoices(IBasicEditingContext context) Get the list of choices for this component.
List	getChoiceTitles(IBasicEditingContext context) Get the list of choices titles for this component.
List	getChoiceTooltips(IBasicEditingContext context) Get the list of choices tooltips for this component.
protected String	getDropdownValueFromForm(IWizardContext context) Store the value from the htmlb display in the session.
protected List	getListBoxValuesFromForm(IWizardContext context)
protected List	getMultiValue(IBasicEditingContext context)
protected String	getRadioButtonInputValueFromForm(IWizardContext context)
protected String	getSingleValue(IBasicEditingContext context)
protected String	getSingleValueTitle(IWizardContext context)
protected String	getSingleValueTooltip(IWizardContext context)
boolean	isComplete(IWizardContext ctx) the default implemention returns true
boolean	isMultiValue()
abstract void	processInput(IWizardContext context) the default implemention does no input processing.
void	setChoices(List choices, IWizardContext context) Set the list of choices for this component.
void	setChoicesTitles(List titles, IWizardContext context) Set the list of titles for this component.
void	setChoicesTooltips(List tooltips, IWizardContext context) Set the list of tooltips for this component.
protected boolean	setMultiValue(List selections, IWizardContext context)
protected boolean	setSingleValue(String selection, IWizardContext context)
void	setWidth(String iWidth)
protected void	updateInputComponent(IWizardContext context)

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

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

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

Constructor Detail

AbstractSelectionComponent

protected AbstractSelectionComponent(String iDefaultCaption,
                                     boolean iIsMultiValue,
                                     List iDefaultChoiceList,
                                     List iDefaultChoiceTitleList,
                                     List iDefaultChoiceTooltipList,
                                     String iChoiceListPath,
                                     String iChoiceTitleListPath,
                                     String iChoiceTooltipListPath,
                                     String iDefaultSingleValue,
                                     List iDefaultMultiValue)

Method Detail

getChoices

public List getChoices(IBasicEditingContext context)

Get the list of choices for this component. Don't modify the list returned by this function!!!. maybe this function should be private???

getChoiceTitles

public List getChoiceTitles(IBasicEditingContext context)

Get the list of choices titles for this component. Don't modify the list returned by this function!!!. maybe this function should be private???

getChoiceTooltips

public List getChoiceTooltips(IBasicEditingContext context)

Get the list of choices tooltips for this component. Don't modify the list returned by this function!!!. maybe this function should be private???

setChoices

public void setChoices(List choices,
                       IWizardContext context)

Set the list of choices for this component. please note that this implementation will reset the display of the htmlb display of the component, such that any modifications done to the display disappear.

setChoicesTitles

public void setChoicesTitles(List titles,
                             IWizardContext context)

Set the list of titles for this component. please note that this implementation will reset the display of the htmlb display of the component, such that any modifications done to the display disappear.

setChoicesTooltips

public void setChoicesTooltips(List tooltips,
                               IWizardContext context)

Set the list of tooltips for this component. please note that this implementation will reset the display of the htmlb display of the component, such that any modifications done to the display disappear.

setWidth

public void setWidth(String iWidth)

isMultiValue

public boolean isMultiValue()

updateInputComponent

protected void updateInputComponent(IWizardContext context)

processInput

public abstract void processInput(IWizardContext context)

Description copied from class: AbstractWizardComponent

the default implemention does no input processing.

Specified by:

processInput in interface IWizardComponent

Specified by:

processInput in class AbstractInputComponent

setSingleValue

protected boolean setSingleValue(String selection,
                                 IWizardContext context)

setMultiValue

protected boolean setMultiValue(List selections,
                                IWizardContext context)

getSingleValue

protected String getSingleValue(IBasicEditingContext context)

getSingleValueTitle

protected String getSingleValueTitle(IWizardContext context)

getSingleValueTooltip

protected String getSingleValueTooltip(IWizardContext context)

getMultiValue

protected List getMultiValue(IBasicEditingContext context)

createRadioButtonInputComponent

protected Component createRadioButtonInputComponent(IBasicEditingContext context)

getRadioButtonInputValueFromForm

protected String getRadioButtonInputValueFromForm(IWizardContext context)

createListBoxInputComponent

protected Component createListBoxInputComponent(IBasicEditingContext context)

getListBoxValuesFromForm

protected List getListBoxValuesFromForm(IWizardContext context)

createDropDownInputComponent

protected Component createDropDownInputComponent(IBasicEditingContext context)

getDropdownValueFromForm

protected String getDropdownValueFromForm(IWizardContext context)

Store the value from the htmlb display in the session.

createCheckboxGroupInputComponent

protected Component createCheckboxGroupInputComponent(IBasicEditingContext context)

getCheckboxGroupValuesFromForm

protected List getCheckboxGroupValuesFromForm(IWizardContext context)

isComplete

public boolean isComplete(IWizardContext ctx)

Description copied from class: AbstractWizardComponent

the default implemention returns true

Overrides:

isComplete in class AbstractInputComponent