TextFieldDescriptor (PingFederate Server SDK)

java.lang.Object
- org.sourceid.saml20.adapter.gui.FieldDescriptor
- - org.sourceid.saml20.adapter.gui.AbstractTextFieldDescriptor
  - - org.sourceid.saml20.adapter.gui.TextFieldDescriptor

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SecretReferenceFieldDescriptor
```
public class TextFieldDescriptor
extends AbstractTextFieldDescriptor
```
A field descriptor that will render a text field 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.FieldDescriptor
  FieldDescriptor.FieldValidationWrapper

Constructor Summary

Constructors
Constructor	Description
`TextFieldDescriptor(String name, String description)`	Create a new TextFieldDescriptor.
`TextFieldDescriptor(String name, String description, boolean encrypted)`	Create a new TextFieldDescriptor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

boolean isEncrypted()
Encrypt this text field?
- Methods inherited from class org.sourceid.saml20.adapter.gui.AbstractTextFieldDescriptor
  getSize, setSize
- 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 Detail
  - TextFieldDescriptor
```
public TextFieldDescriptor(String name,
                           String description)
```
    Create a new TextFieldDescriptor. This is the same as using the constructor TextFieldDescriptor(String, String, boolean) with false for the last argument.
  - TextFieldDescriptor
```
public TextFieldDescriptor(String name,
                           String description,
                           boolean encrypted)
```
    Create a new TextFieldDescriptor.
    
    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 - The field description displayed in the administrative console.
    
    encrypted - Should this field encrypt the value (render it as a password field in the GUI and encrypt the value in the backing configuration file).
- Method Detail
  - isEncrypted
```
public boolean isEncrypted()
```
    Encrypt this text field?