Package org.sourceid.saml20.adapter.gui

Class CheckBoxFieldDescriptor

java.lang.Object

org.sourceid.saml20.adapter.gui.FieldDescriptor

org.sourceid.saml20.adapter.gui.CheckBoxFieldDescriptor

All Implemented Interfaces:

Serializable

public class CheckBoxFieldDescriptor
extends FieldDescriptor

A field descriptor that will render a check box on the GUI configuration screen.

See Also:

• GuiConfigDescriptor.addField(FieldDescriptor)
• GuiConfigDescriptor.addAdvancedField(FieldDescriptor)
• TableDescriptor.addRowField(FieldDescriptor)
• Field.getValueAsBoolean()
• Serialized Form

Nested Class Summary

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

FieldDescriptor.FieldValidationWrapper

Constructor Summary

Constructors

Constructor	Description
CheckBoxFieldDescriptor(String name, String description)	Create a new CheckBoxFieldDescriptor.

Method Summary

Modifier and Type	Method	Description
void	setDefaultForLegacyConfig(boolean defaultValue)	This method allows a newly added field to have a default value specifically for instances of a plugin that were created before adding this field.
void	setDefaultValue(boolean defaultValue)	Set the default value for this individual field as a boolean.

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

addValidator, addValidator, getDefaultForLegacyConfig, getDefaultValue, getDescription, getFormattedValue, 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 Details

CheckBoxFieldDescriptor

public CheckBoxFieldDescriptor(String name,
 String description)

Create a new CheckBoxFieldDescriptor.

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.

Method Details

setDefaultValue

public void setDefaultValue(boolean defaultValue)

Set the default value for this individual field as a boolean.

Parameters:

defaultValue - The default value for this field.

setDefaultForLegacyConfig

public void setDefaultForLegacyConfig(boolean defaultValue)

This method allows a newly added field to have a default value specifically for instances of a plugin that were created before adding this field.

Parameters:

defaultValue - The default value that should be used for legacy configurations.