com.sapportals.admin.wizardframework.components
Class ListSelectionComponent

java.lang.Object
  |
  +--com.sapportals.admin.wizardframework.components.AbstractWizardComponent
        |
        +--com.sapportals.admin.wizardframework.components.AbstractInputComponent
              |
              +--com.sapportals.admin.wizardframework.components.AbstractSelectionComponent
                    |
                    +--com.sapportals.admin.wizardframework.components.ListSelectionComponent

All Implemented Interfaces:

IDependencyObject, IWizardComponent

public class ListSelectionComponent

extends AbstractSelectionComponent

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

ListSelectionComponent(java.lang.String caption, java.util.List choices, java.util.List choiceTitles, java.util.List defaultSelection, boolean isMandatory)

ListSelectionComponent(java.lang.String caption, java.util.List choices, java.util.List choiceTitles, java.util.List defaultSelection, boolean isMandatory, int iLayout, int iPadding)

ListSelectionComponent(java.lang.String caption, java.util.List choices, java.util.List choiceTitles, java.util.List defaultSelection, boolean isMandatory, int iLayout, int iPadding, java.lang.String captionWidth, java.lang.String fieldWidth, int componentHeight)

ListSelectionComponent(java.lang.String iDefaultCaption, java.lang.String iChoiceListPath, java.util.List iDefaultSelection, int iWidth)
Creates a ListSelectionComponent with the given caption and default selection that will take it's list of choices from the session.

ListSelectionComponent(java.lang.String iDefaultCaption, java.lang.String iChoiceListPath, java.util.List iDefaultSelection, int iLayout, int iPadding, int iWidth)
Creates a ListSelectionComponent with the given caption and default selection that will take it's list of choices from the session.

ListSelectionComponent(java.lang.String caption, java.lang.String choicesPath, java.lang.String choiceTitlesPath, java.util.List defaultSelection, boolean isMandatory)

ListSelectionComponent(java.lang.String caption, java.lang.String choicesPath, java.lang.String choiceTitlesPath, java.util.List defaultSelection, boolean isMandatory, int iLayout, int iPadding)

ListSelectionComponent(java.lang.String caption, java.lang.String choicesPath, java.lang.String choiceTitlesPath, java.util.List defaultSelection, boolean isMandatory, int iLayout, int iPadding, java.lang.String captionWidth, java.lang.String fieldWidth, int componentHeight)

ListSelectionComponent(java.lang.String iDefaultCaption, java.lang.String iChoiceListPath, java.lang.String iChoiceTitleListPath, java.util.List iDefaultSelection, int iLayout, int iPadding, int iWidth)
Creates a ListSelectionComponent with the given caption and default selection that will take it's list of choices from the session.

Method Summary

protected com.sapportals.htmlb.Component	createInputComponent(IBasicEditingContext context) creates the htmlb input control of this component
com.sapportals.htmlb.ListBox	getInputComponent(IBasicEditingContext context)
com.sapportals.htmlb.ListBox	getListComponent(IBasicEditingContext context)
java.util.List	getValue(IWizardContext context)
void	processInput(IWizardContext context) reads the new value from the submitted form and stores it in the session
void	setFieldWidth(java.lang.String fieldWidth)
boolean	setValue(java.util.List newValue, IWizardContext context) set this component's value to newValue

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

createCheckboxGroupInputComponent, createDropDownInputComponent, createListBoxInputComponent, createRadioButtonInputComponent, getCheckboxGroupValuesFromForm, getChoices, getChoiceTitles, getChoiceTooltips, getDropdownValueFromForm, getListBoxValuesFromForm, getMultiValue, getRadioButtonInputValueFromForm, getSingleValue, getSingleValueTitle, getSingleValueTooltip, isComplete, isMultiValue, setChoices, setChoicesTitles, setChoicesTooltips, setMultiValue, setSingleValue, setWidth, updateInputComponent

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

clear, clearIfInconsistent, 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

ListSelectionComponent

public ListSelectionComponent(java.lang.String iDefaultCaption,
                              java.lang.String iChoiceListPath,
                              java.util.List iDefaultSelection,
                              int iWidth)

Creates a ListSelectionComponent with the given caption and default selection that will take it's list of choices from the session.

Parameters:

iCaption - - the caption for the component

iChoiceList - - the path of the list of choices for this component in the session.

iDefaultSelection - - the default selection for this component

ListSelectionComponent

public ListSelectionComponent(java.lang.String iDefaultCaption,
                              java.lang.String iChoiceListPath,
                              java.util.List iDefaultSelection,
                              int iLayout,
                              int iPadding,
                              int iWidth)

Creates a ListSelectionComponent with the given caption and default selection that will take it's list of choices from the session.

Parameters:

iCaption - - the caption for the component

iChoiceList - - the path of the list of choices for this component in the session.

iDefaultSelection - - the default selection for this component

ListSelectionComponent

public ListSelectionComponent(java.lang.String iDefaultCaption,
                              java.lang.String iChoiceListPath,
                              java.lang.String iChoiceTitleListPath,
                              java.util.List iDefaultSelection,
                              int iLayout,
                              int iPadding,
                              int iWidth)

Creates a ListSelectionComponent with the given caption and default selection that will take it's list of choices from the session.

Parameters:

iCaption - - the caption for the component

iChoiceList - - the path of the list of choices for this component in the session.

iDefaultSelection - - the default selection for this component

ListSelectionComponent

public ListSelectionComponent(java.lang.String caption,
                              java.util.List choices,
                              java.util.List choiceTitles,
                              java.util.List defaultSelection,
                              boolean isMandatory)

ListSelectionComponent

public ListSelectionComponent(java.lang.String caption,
                              java.lang.String choicesPath,
                              java.lang.String choiceTitlesPath,
                              java.util.List defaultSelection,
                              boolean isMandatory)

ListSelectionComponent

public ListSelectionComponent(java.lang.String caption,
                              java.util.List choices,
                              java.util.List choiceTitles,
                              java.util.List defaultSelection,
                              boolean isMandatory,
                              int iLayout,
                              int iPadding)

ListSelectionComponent

public ListSelectionComponent(java.lang.String caption,
                              java.lang.String choicesPath,
                              java.lang.String choiceTitlesPath,
                              java.util.List defaultSelection,
                              boolean isMandatory,
                              int iLayout,
                              int iPadding)

ListSelectionComponent

public ListSelectionComponent(java.lang.String caption,
                              java.util.List choices,
                              java.util.List choiceTitles,
                              java.util.List defaultSelection,
                              boolean isMandatory,
                              int iLayout,
                              int iPadding,
                              java.lang.String captionWidth,
                              java.lang.String fieldWidth,
                              int componentHeight)

ListSelectionComponent

public ListSelectionComponent(java.lang.String caption,
                              java.lang.String choicesPath,
                              java.lang.String choiceTitlesPath,
                              java.util.List defaultSelection,
                              boolean isMandatory,
                              int iLayout,
                              int iPadding,
                              java.lang.String captionWidth,
                              java.lang.String fieldWidth,
                              int componentHeight)

Method Detail

getListComponent

public com.sapportals.htmlb.ListBox getListComponent(IBasicEditingContext context)

getInputComponent

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

processInput

public void processInput(IWizardContext context)

reads the new value from the submitted form and stores it in the session

Overrides:

processInput in class AbstractSelectionComponent

createInputComponent

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

creates the htmlb input control of this component

Overrides:

createInputComponent in class AbstractInputComponent

getValue

public java.util.List getValue(IWizardContext context)

setValue

public boolean setValue(java.util.List newValue,
                        IWizardContext context)

set this component's value to newValue

setFieldWidth

public void setFieldWidth(java.lang.String fieldWidth)