com.sapportals.admin.wizardframework.components

Class RadioButtonSelectionComponent

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

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 RadioButtonSelectionComponent
extends AbstractSelectionComponent

The class that represents the radio button selection input component.
A radio button group user interface is used for a wizard component that allows single selection.

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
RadioButtonSelectionComponent() Deprecated. A blank constructor.
RadioButtonSelectionComponent(String iCaption) Deprecated. A constructor that sets a caption.
RadioButtonSelectionComponent(String iCaption, List iChoiceList) Deprecated. A constructor that sets a caption, and a fixed list of choices.
RadioButtonSelectionComponent(String caption, List choices, List choiceTitles, List choiceTooltips, String defaultSelection, boolean isMandatory) Deprecated. A constructor that sets a caption, a fixed list of choices, a list of titles for the choices, tooltips for the choices, a default selection and sets the component to mandatory (true).
RadioButtonSelectionComponent(String caption, List choices, List choiceTitles, List choiceTooltips, String defaultSelection, boolean isMandatory, int iLayout, int iPadding) Deprecated. A constructor that sets a caption, a fixed list of choices, a list of titles for the choices, tooltips for the choices, a default selection and sets the component to mandatory (true), and sets a layout and padding.
RadioButtonSelectionComponent(String iCaption, List iChoiceList, List iChoiceTitleList, String iDefaultSelection) Deprecated. A constructor that sets a caption, a fixed list of choices, a list of titles for the choices, and a default selection.
RadioButtonSelectionComponent(String iCaption, List iChoiceList, List iChoiceTitleList, String iDefaultSelection, int iLayout, int iPadding) Deprecated. A constructor that sets a caption, a fixed list of choices, a list of titles for the choices, and a default selection.
RadioButtonSelectionComponent(String iCaption, List iChoiceList, String iDefaultSelection) Deprecated. A constructor that sets a caption, a fixed list of choices, and a default selection.
RadioButtonSelectionComponent(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, a layout and padding.
RadioButtonSelectionComponent(String iDefaultCaption, String iChoiceListPath) Deprecated. A constructor that sets a default caption, and a path for the list of choices.
RadioButtonSelectionComponent(String iDefaultCaption, String iChoiceListPath, String iDefaultSelection) Deprecated. A constructor that sets a default caption, a path for the list of choices, and a default selection.
RadioButtonSelectionComponent(String iDefaultCaption, String iChoiceListPath, String iDefaultSelection, int iLayout, int iPadding) Deprecated. A constructor that sets a default caption, a path for the list of choices, a default selection, a layout and padding.
RadioButtonSelectionComponent(String iDefaultCaption, String iChoiceListPath, String iChoiceTitleListPath, String iDefaultSelection) Deprecated. A constructor that sets a default caption, a path for the list of choices, a path for the titles of the choices, and a default selection.
RadioButtonSelectionComponent(String iDefaultCaption, String iChoiceListPath, String iChoiceTitleListPath, String iDefaultSelection, int iLayout, int iPadding) Deprecated. A constructor that sets a default caption, a path for the list of choices, a path for the titles of the choices, a default selection, a layout and padding.
RadioButtonSelectionComponent(String caption, String choicesPath, String choiceTitlesPath, String choiceTooltipsPath, String defaultSelection, boolean isMandatory) Deprecated. A constructor that sets a caption, a path for the list of choices, a path for the list of titles for the choices, a path for the tooltips of the choices, a default selection and sets the component to mandatory (true).
RadioButtonSelectionComponent(String caption, String choicesPath, String choiceTitlesPath, String choiceTooltipsPath, String defaultSelection, boolean isMandatory, int iLayout, int iPadding, String componentWidth, String captionWidth) Deprecated. A constructor that sets a caption, a path for the list of choices, a path for the list of titles for the choices, a path for the tooltips of the choices, a default selection and sets the component to mandatory (true), sets a width for the component, and a width for the caption.

Method Summary

Modifier and Type	Method and Description
protected com.sapportals.htmlb.Component	createInputComponent(IBasicEditingContext ctx) Deprecated. Creates the HTMLB input control of this component.
com.sapportals.htmlb.RadioButtonGroup	getInputComponent(IBasicEditingContext context) Deprecated. Gets the input component.
com.sapportals.htmlb.RadioButtonGroup	getRadioButtonGroup(IBasicEditingContext context) Deprecated. Gets the radio button component.
String	getValue(IWizardContext context) Deprecated. Gets the current value of a component.
String	getValueTitle(IWizardContext context) Deprecated. Gets the title for a component.
void	processInput(IWizardContext context) Deprecated. Saves to the data model the values entered into wizard controls by the administrator.
boolean	setValue(String newValue, IWizardContext context) Deprecated. Sets the radio button component value to the specified value.

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

RadioButtonSelectionComponent

public RadioButtonSelectionComponent()

Deprecated.

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

RadioButtonSelectionComponent

public RadioButtonSelectionComponent(String iCaption)

Deprecated.

A constructor that sets a caption.

Parameters:

iCaption - a caption

RadioButtonSelectionComponent

public RadioButtonSelectionComponent(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

RadioButtonSelectionComponent

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

Deprecated.

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

Parameters:

iCaption - a caption

iChoiceList - a list of choices

iDefaultSelection - a default selection

RadioButtonSelectionComponent

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

Deprecated.

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

Parameters:

iCaption - a caption

iChoiceList - a list of choices

iChoiceTitleList - a list of title for the choice

iDefaultSelection - a default selection

RadioButtonSelectionComponent

public RadioButtonSelectionComponent(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, a layout and padding.

Parameters:

iCaption - a caption

iChoiceList - a list of choices

iDefaultSelection - a default selection

iLayout - a layout

iPadding - padding

RadioButtonSelectionComponent

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

Deprecated.

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

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

RadioButtonSelectionComponent

public RadioButtonSelectionComponent(String iDefaultCaption,
                                     String iChoiceListPath)

Deprecated.

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

Parameters:

iDefaultCaption - a default caption

iChoiceListPath - a path for the list of choices

RadioButtonSelectionComponent

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

Deprecated.

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

Parameters:

iDefaultCaption - a default caption

iChoiceListPath - a path for the list of choices

iDefaultSelection - a default selection

RadioButtonSelectionComponent

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

Deprecated.

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

Parameters:

iDefaultCaption - a default caption

iChoiceListPath - a path for the list of choices

iChoiceTitleListPath - a path for titles of the choices

iDefaultSelection - a default selection

RadioButtonSelectionComponent

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

Deprecated.

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

Parameters:

iDefaultCaption - a default caption

iChoiceListPath - a path for the list of choices

iDefaultSelection - a default selection

iLayout - a layout

iPadding - padding

RadioButtonSelectionComponent

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

Deprecated.

A constructor that sets a default caption, a path for the list of 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 list of choices

iChoiceTitleListPath - a path for titles of the choices

iDefaultSelection - a default selection

iLayout - a layout

iPadding - padding

RadioButtonSelectionComponent

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

Deprecated.

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

Parameters:

caption - a caption

choices - a list of choices

choiceTitles - a list of titles for the choices

choiceTooltips - tooltips for the choices

defaultSelection - a default selection

isMandatory - true sets the component to mandatory

RadioButtonSelectionComponent

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

Deprecated.

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

Parameters:

caption - a caption

choicesPath - a path for the list of choices

choiceTitlesPath - a path for the list of titles for the choices

choiceTooltipsPath - a path for the tooltips for the choices

defaultSelection - a default selection

isMandatory - true sets the component to mandatory

RadioButtonSelectionComponent

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

Deprecated.

A constructor that sets a caption, a fixed list of choices, a list of titles for the choices, tooltips for the choices, a default selection and sets the component to mandatory (true), and sets a layout and padding.

Parameters:

caption - a caption

choices - a list of choices

choiceTitles - a list of titles for the choices

choiceTooltips - tooltips for the choices

defaultSelection - a default selection

isMandatory - true sets the component to mandatory

iLayout - a layout

iPadding - padding

RadioButtonSelectionComponent

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

Deprecated.

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

Parameters:

caption - a caption

choicesPath - a path for the list of choices

choiceTitlesPath - a path for the list of titles for the choices

choiceTooltipsPath - a path for the tooltips for the choices

defaultSelection - a default selection

isMandatory - true sets the component to mandatory

iLayout - a layout

iPadding - padding

componentWidth - a width for the component

captionWidth - a width for the caption

Method Detail

getRadioButtonGroup

public com.sapportals.htmlb.RadioButtonGroup getRadioButtonGroup(IBasicEditingContext context)

Deprecated.

Gets the radio button 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 editing context

Returns:

the radio button component

getInputComponent

public com.sapportals.htmlb.RadioButtonGroup getInputComponent(IBasicEditingContext 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 editing 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 ctx)

Deprecated.

Creates the HTMLB input control of this component.

Specified by:

createInputComponent in class AbstractInputComponent

Parameters:

ctx - the current editing context

Returns:

the HTMLB input control

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 this component

getValueTitle

public String getValueTitle(IWizardContext context)

Deprecated.

Gets the title for a component.

Parameters:

context - the current wizard context

Returns:

the title

setValue

public boolean setValue(String newValue,
                        IWizardContext context)

Deprecated.

Sets the radio button component value to the specified value. The value can be true or false.

Parameters:

newValue - a value for the component

context - the current wizard context

Returns:

true or false