com.sapportals.admin.wizardframework.components
Class DropdownSelectionComponent

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.DropdownSelectionComponent

All Implemented Interfaces:

IDependencyObject, IWizardComponent

public class DropdownSelectionComponent

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

DropdownSelectionComponent()
Creates a 'blank' DropdownSelectionComponent. you'll have to set caption, choices and default selection at runtime.

DropdownSelectionComponent(java.lang.String iCaption)
Creates a DropdownSelectionComponent with the given caption. you'll have to set the choices at runtime.

DropdownSelectionComponent(java.lang.String iCaption, java.util.List iChoiceList)
Creates a DropdownSelectionComponent with the given caption and a fixed list of choices.

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

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

DropdownSelectionComponent(java.lang.String iCaption, java.util.List iChoiceList, java.util.List iChoiceTitleList, java.lang.String iDefaultSelection)
Creates a DropdownSelectionComponent with the given caption, choices and default selection.

DropdownSelectionComponent(java.lang.String iCaption, java.util.List iChoiceList, java.util.List iChoiceTitleList, java.lang.String iDefaultSelection, int iLayout, int iPadding)
Creates a DropdownSelectionComponent with the given caption, choices and default selection.

DropdownSelectionComponent(java.lang.String caption, java.util.List choices, java.util.List choiceTitles, java.lang.String defaultSelection, int iLayout, int iPadding, java.lang.String captionWidth, java.lang.String fieldWidth)

DropdownSelectionComponent(java.lang.String iCaption, java.util.List iChoiceList, java.lang.String iDefaultSelection)
Creates a DropdownSelectionComponent with the given caption, choices and default selection.

DropdownSelectionComponent(java.lang.String iCaption, java.util.List iChoiceList, java.lang.String iDefaultSelection, int iLayout, int iPadding)
Creates a DropdownSelectionComponent with the given caption, choices and default selection.

DropdownSelectionComponent(java.lang.String iDefaultCaption, java.lang.String iChoiceListPath)
Creates a DropdownSelectionComponent with the given caption that will take it's list of choices from the session.

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

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

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

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

DropdownSelectionComponent(java.lang.String caption, java.lang.String choicesPath, java.lang.String choiceTitlesPath, java.lang.String defaultSelection, int iLayout, int iPadding, java.lang.String captionWidth, java.lang.String fieldWidth)

DropdownSelectionComponent(java.lang.String caption, java.lang.String choicesPath, java.lang.String choiceTitlesPath, java.lang.String choiceTooltipsPath, java.lang.String defaultSelection, boolean isMandatory)

DropdownSelectionComponent(java.lang.String caption, java.lang.String choicesPath, java.lang.String choiceTitlesPath, java.lang.String choiceTooltipsPath, java.lang.String defaultSelection, boolean isMandatory, int iLayout, int iPadding, java.lang.String captionWidth, java.lang.String fieldWidth)

Method Summary

protected com.sapportals.htmlb.Component	createInputComponent(IBasicEditingContext context) creates the htmlb input control of this component
com.sapportals.htmlb.Component	getControlInFocus(IWizardContext ctx)
com.sapportals.htmlb.DropdownListBox	getInputComponent(IBasicEditingContext ctx)
com.sapportals.htmlb.DropdownListBox	getListComponent(IWizardContext context)
java.lang.String	getValue(IWizardContext context)
java.lang.String	getValueTitle(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.lang.String 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, 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

DropdownSelectionComponent

public DropdownSelectionComponent()

Creates a 'blank' DropdownSelectionComponent. you'll have to set caption, choices and default selection at runtime.

DropdownSelectionComponent

public DropdownSelectionComponent(java.lang.String iCaption)

Creates a DropdownSelectionComponent with the given caption. you'll have to set the choices at runtime.

Parameters:

iCaption - - the caption for the component

DropdownSelectionComponent

public DropdownSelectionComponent(java.lang.String iCaption,
                                  java.util.List iChoiceList)

Creates a DropdownSelectionComponent with the given caption and a fixed list of choices.

Parameters:

iCaption - - the caption for the component

iChoiceList - - the list of choices for this component

DropdownSelectionComponent

public DropdownSelectionComponent(java.lang.String iCaption,
                                  java.util.List iChoiceList,
                                  java.lang.String iDefaultSelection)

Creates a DropdownSelectionComponent with the given caption, choices and default selection.

Parameters:

iCaption - - the caption for the component

iChoiceList - - the list of choices for this component

iDefaultSelection - - the default selection for this component

DropdownSelectionComponent

public DropdownSelectionComponent(java.lang.String iCaption,
                                  java.util.List iChoiceList,
                                  java.util.List iChoiceTitleList,
                                  java.lang.String iDefaultSelection)

Creates a DropdownSelectionComponent with the given caption, choices and default selection.

Parameters:

iCaption - - the caption for the component

iChoiceList - - the list of choices for this component

iDefaultSelection - - the default selection for this component

DropdownSelectionComponent

public DropdownSelectionComponent(java.lang.String iCaption,
                                  java.util.List iChoiceList,
                                  java.lang.String iDefaultSelection,
                                  int iLayout,
                                  int iPadding)

Creates a DropdownSelectionComponent with the given caption, choices and default selection.

Parameters:

iCaption - - the caption for the component

iChoiceList - - the list of choices for this component

iDefaultSelection - - the default selection for this component

DropdownSelectionComponent

public DropdownSelectionComponent(java.lang.String iCaption,
                                  java.util.List iChoiceList,
                                  java.util.List iChoiceTitleList,
                                  java.lang.String iDefaultSelection,
                                  int iLayout,
                                  int iPadding)

Creates a DropdownSelectionComponent with the given caption, choices and default selection.

Parameters:

iCaption - - the caption for the component

iChoiceList - - the list of choices for this component

iDefaultSelection - - the default selection for this component

DropdownSelectionComponent

public DropdownSelectionComponent(java.lang.String caption,
                                  java.util.List choices,
                                  java.util.List choiceTitles,
                                  java.lang.String defaultSelection,
                                  int iLayout,
                                  int iPadding,
                                  java.lang.String captionWidth,
                                  java.lang.String fieldWidth)

DropdownSelectionComponent

public DropdownSelectionComponent(java.lang.String caption,
                                  java.lang.String choicesPath,
                                  java.lang.String choiceTitlesPath,
                                  java.lang.String defaultSelection,
                                  int iLayout,
                                  int iPadding,
                                  java.lang.String captionWidth,
                                  java.lang.String fieldWidth)

DropdownSelectionComponent

public DropdownSelectionComponent(java.lang.String iDefaultCaption,
                                  java.lang.String iChoiceListPath)

Creates a DropdownSelectionComponent with the given caption 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.

DropdownSelectionComponent

public DropdownSelectionComponent(java.lang.String iDefaultCaption,
                                  java.lang.String iChoiceListPath,
                                  java.lang.String iDefaultSelection)

Creates a DropdownSelectionComponent 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

DropdownSelectionComponent

public DropdownSelectionComponent(java.lang.String iDefaultCaption,
                                  java.lang.String iChoiceListPath,
                                  java.lang.String iChoiceTitleListPath,
                                  java.lang.String iDefaultSelection)

Creates a DropdownSelectionComponent 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

DropdownSelectionComponent

public DropdownSelectionComponent(java.lang.String iDefaultCaption,
                                  java.lang.String iChoiceListPath,
                                  java.lang.String iDefaultSelection,
                                  int iLayout,
                                  int iPadding)

Creates a DropdownSelectionComponent 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

DropdownSelectionComponent

public DropdownSelectionComponent(java.lang.String iDefaultCaption,
                                  java.lang.String iChoiceListPath,
                                  java.lang.String iChoiceTitleListPath,
                                  java.lang.String iDefaultSelection,
                                  int iLayout,
                                  int iPadding)

Creates a DropdownSelectionComponent 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

DropdownSelectionComponent

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

DropdownSelectionComponent

public DropdownSelectionComponent(java.lang.String caption,
                                  java.lang.String choicesPath,
                                  java.lang.String choiceTitlesPath,
                                  java.lang.String choiceTooltipsPath,
                                  java.lang.String defaultSelection,
                                  boolean isMandatory)

DropdownSelectionComponent

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

DropdownSelectionComponent

public DropdownSelectionComponent(java.lang.String caption,
                                  java.lang.String choicesPath,
                                  java.lang.String choiceTitlesPath,
                                  java.lang.String choiceTooltipsPath,
                                  java.lang.String defaultSelection,
                                  boolean isMandatory,
                                  int iLayout,
                                  int iPadding,
                                  java.lang.String captionWidth,
                                  java.lang.String fieldWidth)

Method Detail

getListComponent

public com.sapportals.htmlb.DropdownListBox getListComponent(IWizardContext 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.lang.String getValue(IWizardContext context)

getValueTitle

public java.lang.String getValueTitle(IWizardContext context)

setValue

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

set this component's value to newValue

setFieldWidth

public void setFieldWidth(java.lang.String fieldWidth)

getControlInFocus

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

Overrides:

getControlInFocus in class AbstractWizardComponent

getInputComponent

public com.sapportals.htmlb.DropdownListBox getInputComponent(IBasicEditingContext ctx)