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

Deprecated.

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

public abstract class AbstractSelectionComponent
extends AbstractInputComponent

The base class that represents a selection 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

Modifier

Constructor and Description

protected

AbstractSelectionComponent(String iDefaultCaption, boolean iIsMultiValue, List iDefaultChoiceList, List iDefaultChoiceTitleList, List iDefaultChoiceTooltipList, String iChoiceListPath, String iChoiceTitleListPath, String iChoiceTooltipListPath, String iDefaultSingleValue, List iDefaultMultiValue) Deprecated. A class constructor that sets a default caption, whether the component allows multiple values, a default choice list, a default list of titles for choices, a default list of tooltips for choices, a choice list path, a choice list title path, a choice list tooltip path, and a default single value.

Method Summary

Modifier and Type	Method and Description
protected com.sapportals.htmlb.Component	createCheckboxGroupInputComponent(IBasicEditingContext context) Deprecated. Creates a checkbox group input component.
protected com.sapportals.htmlb.Component	createDropDownInputComponent(IBasicEditingContext context) Deprecated. Creates a dropdown input component.
protected com.sapportals.htmlb.Component	createListBoxInputComponent(IBasicEditingContext context) Deprecated. Creates a listbox input component.
protected com.sapportals.htmlb.Component	createRadioButtonInputComponent(IBasicEditingContext context) Deprecated. Creates a radio button input component.
protected List	getCheckboxGroupValuesFromForm(IWizardContext context) Deprecated. Gets the checkbox group values from the HTMLB display.
List	getChoices(IBasicEditingContext context) Deprecated. Gets the list of choices for this component.
List	getChoiceTitles(IBasicEditingContext context) Deprecated. Gets the list of titles for the choices for this component.
List	getChoiceTooltips(IBasicEditingContext context) Deprecated. Gets the list of tooltips for the choices for this component.
protected String	getDropdownValueFromForm(IWizardContext context) Deprecated. Gets the dropdown value from the HTMLB display.
protected List	getListBoxValuesFromForm(IWizardContext context) Deprecated. Gets the listbox values from the HTMLB display.
protected List	getMultiValue(IBasicEditingContext context) Deprecated. Gets the list of the selected values.
protected String	getRadioButtonInputValueFromForm(IWizardContext context) Deprecated. Gets a radio button input value from the HTMLB display.
protected String	getSingleValue(IBasicEditingContext context) Deprecated. Gets the value of a single selection.
protected String	getSingleValueTitle(IWizardContext context) Deprecated. Gets the title of a single selection.
protected String	getSingleValueTooltip(IWizardContext context) Deprecated. Gets the tooltip of a single selection.
boolean	isComplete(IWizardContext ctx) Deprecated. Indicates whether a choice has been selected in the component.
boolean	isMultiValue() Deprecated. Indicates whether a selection component enables multiple values.
abstract void	processInput(IWizardContext context) Deprecated. Saves to the data model the values entered into wizard controls by the administrator.
void	setChoices(List choices, IWizardContext context) Deprecated. Sets a list of choices for this component.
void	setChoicesTitles(List titles, IWizardContext context) Deprecated. Sets a list of titles for the choices for this component.
void	setChoicesTooltips(List tooltips, IWizardContext context) Deprecated. Sets a list of tooltips for the choices for this component.
protected boolean	setMultiValue(List selections, IWizardContext context) Deprecated. Sets multiple values as the selection.
protected boolean	setSingleValue(String selection, IWizardContext context) Deprecated.
void	setWidth(String iWidth) Deprecated. Sets a width for a selection component.
protected void	updateInputComponent(IWizardContext context) Deprecated. Updates the input component.

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)

Deprecated.

A class constructor that sets a default caption, whether the component allows multiple values, a default choice list, a default list of titles for choices, a default list of tooltips for choices, a choice list path, a choice list title path, a choice list tooltip path, and a default single value.

Parameters:

iDefaultCaption - a default caption

iIsMultiValue - true enables multiple selection

iDefaultChoiceList - a default list of choices

iDefaultChoiceTitleList - a default list of titles

iDefaultChoiceTooltipList - a default list of tooltips

iChoiceListPath - a path for the choices list

iChoiceTitleListPath - a path for the title list

iChoiceTooltipListPath - a path for the tooltip list

iDefaultSingleValue - a default single value

iDefaultMultiValue - a default multiple value

Method Detail

getChoices

public List getChoices(IBasicEditingContext context)

Deprecated.

Gets the list of choices for this component. Do not modify the list returned by this function.

Parameters:

context - the current editing context

Returns:

a list of choices

getChoiceTitles

public List getChoiceTitles(IBasicEditingContext context)

Deprecated.

Gets the list of titles for the choices for this component. Do not modify the list returned by this function.

Parameters:

context - the current editing context

Returns:

a list of titles

getChoiceTooltips

public List getChoiceTooltips(IBasicEditingContext context)

Deprecated.

Gets the list of tooltips for the choices for this component.

Parameters:

context - the current editing context

Returns:

a list of tooltips

setChoices

public void setChoices(List choices,
                       IWizardContext context)

Deprecated.

Sets a list of choices for this component.
Note: This implementation resets the HTMLB display of the component.

Parameters:

choices - a list of choices

context - the current wizard context

setChoicesTitles

public void setChoicesTitles(List titles,
                             IWizardContext context)

Deprecated.

Sets a list of titles for the choices for this component.
Note: This implementation resets the HTMLB display of the component.

Parameters:

titles - a list of titles

context - the current wizard context

setChoicesTooltips

public void setChoicesTooltips(List tooltips,
                               IWizardContext context)

Deprecated.

Sets a list of tooltips for the choices for this component.
Note: This implementation resets the HTMLB display of the component.

Parameters:

tooltips - a list of tooltips

context - the current wizard contexxt

setWidth

public void setWidth(String iWidth)

Deprecated.

Sets a width for a selection component.

Parameters:

iWidth - a width

isMultiValue

public boolean isMultiValue()

Deprecated.

Indicates whether a selection component enables multiple values.

Returns:

true enables multiple values, false disables multiple values

updateInputComponent

protected void updateInputComponent(IWizardContext context)

Deprecated.

Updates the input component.

Parameters:

context - the current wizard context

processInput

public abstract 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 AbstractInputComponent

Parameters:

context - the current wizard context

setSingleValue

protected boolean setSingleValue(String selection,
                                 IWizardContext context)

Deprecated.

setMultiValue

protected boolean setMultiValue(List selections,
                                IWizardContext context)

Deprecated.

Sets multiple values as the selection.

Parameters:

selections - a list of selections

context - the current wizard context

Returns:

if set finished successfully returns true else returns false

getSingleValue

protected String getSingleValue(IBasicEditingContext context)

Deprecated.

Gets the value of a single selection.

Parameters:

context - the current editing context

Returns:

the value

getSingleValueTitle

protected String getSingleValueTitle(IWizardContext context)

Deprecated.

Gets the title of a single selection.

Parameters:

context - the current wizard context

Returns:

the title

getSingleValueTooltip

protected String getSingleValueTooltip(IWizardContext context)

Deprecated.

Gets the tooltip of a single selection.

Parameters:

context - the current wizard context

Returns:

the tooltip

getMultiValue

protected List getMultiValue(IBasicEditingContext context)

Deprecated.

Gets the list of the selected values.

Parameters:

context - the current editing context

Returns:

the list of selected values

createRadioButtonInputComponent

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

Deprecated.

Creates a radio button input component.

Parameters:

context - the current editing context

Returns:

a radio button component

getRadioButtonInputValueFromForm

protected String getRadioButtonInputValueFromForm(IWizardContext context)

Deprecated.

Gets a radio button input value from the HTMLB display.

Parameters:

context - the current wizard context

Returns:

the radio button input value, null if no radio button is selected

createListBoxInputComponent

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

Deprecated.

Creates a listbox input component.

Parameters:

context - the current editing context

Returns:

a listbox component

getListBoxValuesFromForm

protected List getListBoxValuesFromForm(IWizardContext context)

Deprecated.

Gets the listbox values from the HTMLB display.

Parameters:

context - the current wizard context

Returns:

the list of listbox values

createDropDownInputComponent

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

Deprecated.

Creates a dropdown input component.

Parameters:

context - the current editing context

Returns:

the dropdown component

getDropdownValueFromForm

protected String getDropdownValueFromForm(IWizardContext context)

Deprecated.

Gets the dropdown value from the HTMLB display.

Parameters:

context - the current wizard context

Returns:

the value

createCheckboxGroupInputComponent

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

Deprecated.

Creates a checkbox group input component.

Parameters:

context - the current editing context

Returns:

the checkbox group component

getCheckboxGroupValuesFromForm

protected List getCheckboxGroupValuesFromForm(IWizardContext context)

Deprecated.

Gets the checkbox group values from the HTMLB display.

Parameters:

context - the current wizard context

Returns:

the list of checkbox group values

isComplete

public boolean isComplete(IWizardContext ctx)

Deprecated.

Indicates whether a choice has been selected in the component. The default implementation returns true.

Overrides:

isComplete in class AbstractInputComponent

Parameters:

ctx - the current wizard context

Returns:

true if there is a selection, false no selection