Package org.sourceid.saml20.adapter.gui

Class RadioGroupFieldDescriptor

java.lang.Object

org.sourceid.saml20.adapter.gui.FieldDescriptor

org.sourceid.saml20.adapter.gui.AbstractSelectionFieldDescriptor

org.sourceid.saml20.adapter.gui.RadioGroupFieldDescriptor

All Implemented Interfaces:

Serializable

public class RadioGroupFieldDescriptor
extends AbstractSelectionFieldDescriptor

A field descriptor that will render a group of radio buttons on the GUI configuration screen.

See Also:

GuiConfigDescriptor.addField(FieldDescriptor), GuiConfigDescriptor.addAdvancedField(FieldDescriptor), TableDescriptor.addRowField(FieldDescriptor), Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.sourceid.saml20.adapter.gui.AbstractSelectionFieldDescriptor

AbstractSelectionFieldDescriptor.OptionValue

Nested classes/interfaces inherited from class org.sourceid.saml20.adapter.gui.FieldDescriptor

FieldDescriptor.FieldValidationWrapper

Field Summary

Fields inherited from class org.sourceid.saml20.adapter.gui.AbstractSelectionFieldDescriptor

NONE_SELECTED

Constructor Summary

Constructors

Constructor	Description
RadioGroupFieldDescriptor(String name, String description, String[] optionValues)	Create a new RadioGroupFieldDescriptor with the specified option values.
RadioGroupFieldDescriptor(String name, String description, List<AbstractSelectionFieldDescriptor.OptionValue> optionValues)	Create a new RadioGroupFieldDescriptor with the specified option values.

Method Summary

Methods inherited from class org.sourceid.saml20.adapter.gui.AbstractSelectionFieldDescriptor

getFormattedValue, getOptionValues, setOptionValues

Methods inherited from class org.sourceid.saml20.adapter.gui.FieldDescriptor

addValidator, addValidator, getDefaultForLegacyConfig, getDefaultValue, getDescription, getLabel, getName, getValidationChain, isHidden, setDefaultForLegacyConfig, setDefaultValue, setHidden, setLabel

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RadioGroupFieldDescriptor

public RadioGroupFieldDescriptor(String name,
                                 String description,
                                 String[] optionValues)

Create a new RadioGroupFieldDescriptor with the specified option values.

Parameters:

name - The field name (must be unique per AdapterConfigurationGuiDescriptor or TableDescriptor). This name will also be used as the label for the field in the administrative console. To ensure configuration can be read in future releases of a plugin, it is recommended to not change a field's name - instead use a label to rename it in the administrative console.

description - A helpful description of the field.

optionValues - A String array to build the OptionValue list from. One OptionValue will be created for each value in the array and the name and value fields will be the same.

RadioGroupFieldDescriptor

public RadioGroupFieldDescriptor(String name,
                                 String description,
                                 List<AbstractSelectionFieldDescriptor.OptionValue> optionValues)

Create a new RadioGroupFieldDescriptor with the specified option values.

Parameters:

name - The field name (must be unique per AdapterConfigurationGuiDescriptor or TableDescriptor). This name will also be used as the label for the field in the administrative console. To ensure configuration can be read in future releases of a plugin, it is recommended to not change a field's name - instead use a label to rename it in the administrative console.

description - a helpful description of the field.

optionValues - a List of OptionValues that will make up the available options the user can choose from.