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

Deprecated.

Use Admin Studio Wizard Framework, as described in Creating Administration Interfaces (Web Dynpro) on the Help Portal documentation (help.sap.com).

public class DropdownSelectionComponent
extends AbstractSelectionComponent

The class that represents a dropdown selection input component.

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

Constructors

Constructor and Description
DropdownSelectionComponent() Deprecated. A blank constructor.
DropdownSelectionComponent(String iCaption) Deprecated. A constructor that sets a caption.
DropdownSelectionComponent(String iCaption, List iChoiceList) Deprecated. A constructor that sets a caption and a fixed list of choices.
DropdownSelectionComponent(String caption, List choices, List choiceTitles, List choiceTooltips, String defaultSelection, boolean isMandatory) Deprecated. A constructor that sets a caption, a list of choices, titles for the choices, tooltips, a default selection and sets the component to mandatory.
DropdownSelectionComponent(String caption, List choices, List choiceTitles, List choiceTooltips, String defaultSelection, boolean isMandatory, int iLayout, int iPadding, String captionWidth, String fieldWidth) Deprecated. A constructor that sets a caption, a list of choices, titles for the choices, tooltips, a default selection, sets the component to mandatory, a layout, padding, sets a caption width, and a field width.
DropdownSelectionComponent(String iCaption, List iChoiceList, List iChoiceTitleList, String iDefaultSelection) Deprecated. A constructor that sets a caption, a fixed list of choices, titles for the choices, and a default selection for the drop down.
DropdownSelectionComponent(String iCaption, List iChoiceList, List iChoiceTitleList, String iDefaultSelection, int iLayout, int iPadding) Deprecated. A constructor that sets a caption, a fixed list of choices, titles for the choices, a default selection for the drop down, a layout, and padding.
DropdownSelectionComponent(String caption, List choices, List choiceTitles, String defaultSelection, int iLayout, int iPadding, String captionWidth, String fieldWidth) Deprecated. A constructor that sets a caption, a fixed list of choices, titles for the choices, a default selection for the drop down, a layout, padding, a caption width, and a field width.
DropdownSelectionComponent(String iCaption, List iChoiceList, String iDefaultSelection) Deprecated. A constructor that sets a caption, a fixed list of choices and a default selection for the drop down.
DropdownSelectionComponent(String iCaption, List iChoiceList, String iDefaultSelection, int iLayout, int iPadding) Deprecated. A constructor that sets a caption, a fixed list of choices, a default selection for the drop down, a layout, and padding.
DropdownSelectionComponent(String iDefaultCaption, String iChoiceListPath) Deprecated. A constructor that sets a default caption, and a path for the choices.
DropdownSelectionComponent(String iDefaultCaption, String iChoiceListPath, String iDefaultSelection) Deprecated. A constructor that sets a default caption, a path for the choices, and a default selection.
DropdownSelectionComponent(String iDefaultCaption, String iChoiceListPath, String iDefaultSelection, int iLayout, int iPadding) Deprecated. A constructor that sets a default caption, a path for the choices, a default selection, a layout, and padding
DropdownSelectionComponent(String iDefaultCaption, String iChoiceListPath, String iChoiceTitleListPath, String iDefaultSelection) Deprecated. A constructor that sets a default caption, a path for the choices, a path for the titles of the choices, and a default selection.
DropdownSelectionComponent(String iDefaultCaption, String iChoiceListPath, String iChoiceTitleListPath, String iDefaultSelection, int iLayout, int iPadding) Deprecated. A constructor that sets a default caption, a path for the choices, a path for the titles of the choices, a default selection, a layout and padding
DropdownSelectionComponent(String caption, String choicesPath, String choiceTitlesPath, String defaultSelection, int iLayout, int iPadding, String captionWidth, String fieldWidth) Deprecated. A constructor that sets a caption, a path for the choices, a path for the titles of the choices, a default selection for the drop down, a layout, padding, a caption width, and a field width.
DropdownSelectionComponent(String caption, String choicesPath, String choiceTitlesPath, String choiceTooltipsPath, String defaultSelection, boolean isMandatory) Deprecated. A constructor that sets a caption, a path for the choices, a path for the titles of the choices, a path for the tooltips, a default selection, and sets the component to mandatory.
DropdownSelectionComponent(String caption, String choicesPath, String choiceTitlesPath, String choiceTooltipsPath, String defaultSelection, boolean isMandatory, int iLayout, int iPadding, String captionWidth, String fieldWidth) Deprecated. A constructor that sets a caption, a path for a list of the choices, a path for the titles for the choices, a path for tooltips, a default selection, sets the component to mandatory, a layout, padding, sets a caption width, and a field width.

Method Summary

Modifier and Type	Method and Description
protected com.sapportals.htmlb.Component	createInputComponent(IBasicEditingContext context) Deprecated. Creates a dropdown listbox object.
com.sapportals.htmlb.Component	getControlInFocus(IWizardContext ctx) Deprecated. Gets the component that currently has the focus.
com.sapportals.htmlb.DropdownListBox	getInputComponent(IBasicEditingContext ctx) Deprecated. Gets the dropdown list box object.
com.sapportals.htmlb.DropdownListBox	getListComponent(IWizardContext context) Deprecated. Gets the input component.
String	getValue(IWizardContext context) Deprecated. Gets the current value of a component.
String	getValueTitle(IWizardContext context) Deprecated. Gets the title of the current value of the component.
void	processInput(IWizardContext context) Deprecated. Saves to the data model the values entered into wizard controls by the administrator.
void	setFieldWidth(String fieldWidth) Deprecated. Sets the field width for the component.
boolean	setValue(String newValue, IWizardContext context) Deprecated. Sets the value of the dropdown selection component.

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()

Deprecated.

A blank constructor. The caption, choices and default selection must be set at runtime.

DropdownSelectionComponent

public DropdownSelectionComponent(String iCaption)

Deprecated.

A constructor that sets a caption.

Parameters:

iCaption - a caption

DropdownSelectionComponent

public DropdownSelectionComponent(String iCaption,
                                  List iChoiceList)

Deprecated.

A constructor that sets a caption and a fixed list of choices.

Parameters:

iCaption - a caption

iChoiceList - a list of choices

DropdownSelectionComponent

public DropdownSelectionComponent(String iCaption,
                                  List iChoiceList,
                                  String iDefaultSelection)

Deprecated.

A constructor that sets a caption, a fixed list of choices and a default selection for the drop down.

Parameters:

iCaption - a caption

iChoiceList - a list of choices

iDefaultSelection - a default selection

DropdownSelectionComponent

public DropdownSelectionComponent(String iCaption,
                                  List iChoiceList,
                                  List iChoiceTitleList,
                                  String iDefaultSelection)

Deprecated.

A constructor that sets a caption, a fixed list of choices, titles for the choices, and a default selection for the drop down.

Parameters:

iCaption - a caption

iChoiceList - a list of choices

iChoiceTitleList - a list of titles for the choices

iDefaultSelection - a default selection

DropdownSelectionComponent

public DropdownSelectionComponent(String iCaption,
                                  List iChoiceList,
                                  String iDefaultSelection,
                                  int iLayout,
                                  int iPadding)

Deprecated.

A constructor that sets a caption, a fixed list of choices, a default selection for the drop down, a layout, and padding.

Parameters:

iCaption - a caption

iChoiceList - a list of choices

iDefaultSelection - a default selection

iLayout - a layout

iPadding - padding

DropdownSelectionComponent

public DropdownSelectionComponent(String iCaption,
                                  List iChoiceList,
                                  List iChoiceTitleList,
                                  String iDefaultSelection,
                                  int iLayout,
                                  int iPadding)

Deprecated.

A constructor that sets a caption, a fixed list of choices, titles for the choices, a default selection for the drop down, a layout, and padding.

Parameters:

iCaption - a caption

iChoiceList - a list of choices

iChoiceTitleList - a list of titles for the choices

iDefaultSelection - a default selection

iLayout - a layout

iPadding - padding

DropdownSelectionComponent

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

Deprecated.

A constructor that sets a caption, a fixed list of choices, titles for the choices, a default selection for the drop down, a layout, padding, a caption width, and a field width.

Parameters:

caption - a caption

choices - a list of choices

choiceTitles - a list of titles for the choices

defaultSelection - a default selection

iLayout - a layout

iPadding - padding

captionWidth - a caption width

fieldWidth - a field width

DropdownSelectionComponent

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

Deprecated.

A constructor that sets a caption, a path for the choices, a path for the titles of the choices, a default selection for the drop down, a layout, padding, a caption width, and a field width.

Parameters:

caption - a caption

choicesPath - a path for the choices

choiceTitlesPath - a path for the titles for the choices

defaultSelection - a default selection

iLayout - a layout

iPadding - padding

captionWidth - a caption width

fieldWidth - a field width

DropdownSelectionComponent

public DropdownSelectionComponent(String iDefaultCaption,
                                  String iChoiceListPath)

Deprecated.

A constructor that sets a default caption, and a path for the choices.

Parameters:

iDefaultCaption - a default caption

iChoiceListPath - a path for the choices

DropdownSelectionComponent

public DropdownSelectionComponent(String iDefaultCaption,
                                  String iChoiceListPath,
                                  String iDefaultSelection)

Deprecated.

A constructor that sets a default caption, a path for the choices, and a default selection.

Parameters:

iDefaultCaption - a default caption

iChoiceListPath - a path for the choices

iDefaultSelection - a default selection

DropdownSelectionComponent

public DropdownSelectionComponent(String iDefaultCaption,
                                  String iChoiceListPath,
                                  String iChoiceTitleListPath,
                                  String iDefaultSelection)

Deprecated.

A constructor that sets a default caption, a path for the choices, a path for the titles of the choices, and a default selection.

Parameters:

iDefaultCaption - a default caption

iChoiceListPath - a path for the choices

iChoiceTitleListPath - a path for the titles of the choices

iDefaultSelection - a default selection

DropdownSelectionComponent

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

Deprecated.

A constructor that sets a default caption, a path for the choices, a default selection, a layout, and padding

Parameters:

iDefaultCaption - a default caption

iChoiceListPath - a path for the choices

iDefaultSelection - a default selection

iLayout - a layout

iPadding - padding

DropdownSelectionComponent

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

Deprecated.

A constructor that sets a default caption, a path for the choices, a path for the titles of the choices, a default selection, a layout and padding

Parameters:

iDefaultCaption - a default caption

iChoiceListPath - a path for the choices

iChoiceTitleListPath - a path for the titles of the choices

iDefaultSelection - a default selection

iLayout - a layout

iPadding - padding

DropdownSelectionComponent

public DropdownSelectionComponent(String caption,
                                  List choices,
                                  List choiceTitles,
                                  List choiceTooltips,
                                  String defaultSelection,
                                  boolean isMandatory)

Deprecated.

A constructor that sets a caption, a list of choices, titles for the choices, tooltips, a default selection and sets the component to mandatory.

Parameters:

caption - a default caption

choices - a list of choices

choiceTitles - a list of titles for the choices

choiceTooltips - a list of Tooltips

defaultSelection - a default selection

isMandatory - true sets the component to mandatory

DropdownSelectionComponent

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

Deprecated.

A constructor that sets a caption, a path for the choices, a path for the titles of the choices, a path for the tooltips, a default selection, and sets the component to mandatory.

Parameters:

caption - a default caption

choicesPath - a path for the choices

choiceTitlesPath - a path for the titles of the choices

choiceTooltipsPath - a path for the tooltips

defaultSelection - a default selection

isMandatory - true sets the component to mandatory

DropdownSelectionComponent

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

Deprecated.

A constructor that sets a caption, a list of choices, titles for the choices, tooltips, a default selection, sets the component to mandatory, a layout, padding, sets a caption width, and a field width.

Parameters:

caption - a default caption

choices - a list of choices

choiceTitles - a list of titles for the choices

choiceTooltips - a list of tooltips

defaultSelection - a default selection

isMandatory - true sets the component to mandatory

iLayout - a layout

iPadding - padding

captionWidth - a caption width

fieldWidth - a field width

DropdownSelectionComponent

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

Deprecated.

A constructor that sets a caption, a path for a list of the choices, a path for the titles for the choices, a path for tooltips, a default selection, sets the component to mandatory, a layout, padding, sets a caption width, and a field width.

Parameters:

caption - a default caption

choicesPath - a path for the choices

choiceTitlesPath - a path for the titles of the choices

choiceTooltipsPath - a path for tooltips

defaultSelection - a default selection

isMandatory - true sets the component to mandatory

iLayout - a layout

iPadding - padding

captionWidth - a caption width

fieldWidth - a field width

Method Detail

getListComponent

public com.sapportals.htmlb.DropdownListBox getListComponent(IWizardContext context)

Deprecated.

Gets the input component. Returns the same component in the same request. If this HTMLB component is modified (for example, change its graphic appearance, define client events, etc) before it is displayed, it affects the component when it is displayed by the getDisplay function.
Use this HTMLB component if you override getDisplay to define a different component layout.

Parameters:

context - the current wizard context

Returns:

the input component

processInput

public void processInput(IWizardContext context)

Deprecated.

Saves to the data model the values entered into wizard controls by the administrator. The default implementation calls the pane�s myProcessInput method, and then calls processInput on all the wizard components within the pane.
Implement this method to save to the data model the data from any HTMLB controls that you created in the pane.
This method is called after a user clicks a toolbar button, causing a new request to be made to the wizard component.

Specified by:

processInput in interface IWizardComponent

Specified by:

processInput in class AbstractSelectionComponent

Parameters:

context - the current wizard context

createInputComponent

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

Deprecated.

Creates a dropdown listbox object.

Specified by:

createInputComponent in class AbstractInputComponent

Parameters:

context - the current editing context

Returns:

a dropdown listbox

getValue

public String getValue(IWizardContext context)

Deprecated.

Gets the current value of a component.

Parameters:

context - the current wizard context

Returns:

the current value of the component

getValueTitle

public String getValueTitle(IWizardContext context)

Deprecated.

Gets the title of the current value of the component.

Parameters:

context - the current wizard context

Returns:

the title of the current value

setValue

public boolean setValue(String newValue,
                        IWizardContext context)

Deprecated.

Sets the value of the dropdown selection component. Always returns true.

Parameters:

newValue - a value

context - the current wizard context

Returns:

true

setFieldWidth

public void setFieldWidth(String fieldWidth)

Deprecated.

Sets the field width for the component.

Parameters:

fieldWidth - a field width

getControlInFocus

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

Deprecated.

Gets the component that currently has the focus.

Specified by:

getControlInFocus in interface IWizardComponent

Overrides:

getControlInFocus in class AbstractWizardComponent

Parameters:

ctx - the current wizard context

Returns:

a component object

getInputComponent

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

Deprecated.

Gets the dropdown list box object.

Parameters:

ctx - the current editing context

Returns:

the dropdown list box component