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

public class RadioButtonSelectionComponent

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

RadioButtonSelectionComponent(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 componentWidth, java.lang.String captionWidth)

Method Summary

protected com.sapportals.htmlb.Component	createInputComponent(IBasicEditingContext ctx) creates the htmlb input control of this component
com.sapportals.htmlb.RadioButtonGroup	getInputComponent(IBasicEditingContext context)
com.sapportals.htmlb.RadioButtonGroup	getRadioButtonGroup(IBasicEditingContext 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
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, 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()

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

RadioButtonSelectionComponent

public RadioButtonSelectionComponent(java.lang.String iCaption)

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

Parameters:

iCaption - - the caption for the component

RadioButtonSelectionComponent

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

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

RadioButtonSelectionComponent

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

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

RadioButtonSelectionComponent

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

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

RadioButtonSelectionComponent

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

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

RadioButtonSelectionComponent

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

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

RadioButtonSelectionComponent

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

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

RadioButtonSelectionComponent

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

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

RadioButtonSelectionComponent

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

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

RadioButtonSelectionComponent

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

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

RadioButtonSelectionComponent

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

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

RadioButtonSelectionComponent

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

RadioButtonSelectionComponent

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

RadioButtonSelectionComponent

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

RadioButtonSelectionComponent

public RadioButtonSelectionComponent(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 componentWidth,
                                     java.lang.String captionWidth)

Method Detail

getRadioButtonGroup

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

getInputComponent

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

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